#10436 closed Bug (fixed)
Application names i18n in the admin app broken
Reported by: | Ramiro Morales | Owned by: | Ramiro Morales |
---|---|---|---|
Component: | contrib.admin | Version: | dev |
Severity: | Normal | Keywords: | blocktrans trans app_label breadcrumbs capfirst title app-loading |
Cc: | Ben Spaulding, Jannis Leidel, basti@…, someuniquename@… | Triage Stage: | Accepted |
Has patch: | yes | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | no | UI/UX: | no |
Description (last modified by )
Having
{% blocktrans with app.name as name %}{{ name }}{% endblocktrans %}
as we currently do in some admin templates shows a decision has been made to allow developers the ability translate application names.
Problem is this feature was DOA (r3270, django/contrib/admin/templates/admin/index.html
, similar template code was copied since then to another file: r8474, app_index.html
)
See relevant django-users and django-i18n threads for the details.
The attached patch implements as a fix the awkward manual steps needed to workaround this bug outlined by the user patrikk in the first thread, plus the following enhancements:
index
,app_index
: Moved the markup-as-translatable of app names from the template to the view code so the translators aren't forced to translate a secondtitle()
'd version of every app name.- Consistent use of the
capfirst
filter on the app names in the breadcrumbs of the different views. - Don't touch
base_site.html
in order to provide for translatability of the app name in the<title>
HTML tag for the application-specific model list view. Instead, implement the needed change in the relevant view (app_index
) (replacing a"%s administration"
msgid with a more translator-friendly"%(app_label)s administration"
one in the process). This will spare translators the need to translate both a"<appname>"
and a"<appname> administration"
literals. - Extend above fixes to other templates that also need them (
delete_confirm.html
,object_history.html
)
Notes to reviewers:
Note 1: This patch has nothing to do with the decision of how we will allow the app name metadata to be specified and marked as translatable in the app itself, that seems to be a new feature I'm sure is being dealt with in other tickets. This ticket is much less ambitious: it's about fixing an old internationalization bug in the presentation of that information (irrespective of its origin in the backend) in the admin contrib app.
Note 2: The change_form.html
template ran the app label through the escape
filter. This has been dropped because it seems inconsistent with what is done in rest of the templates, the app name isn't end user-provided content so the risk of being abused for XSS seems low.
Note 3: There seems to be some inconsistency on how the app name is a) .title()
'd for the name that appear in the caption of model tables (index
and app_index
views) and b) |capfirst
'd for use in HTML title and breadcrumbs. This has been left untouched to avoid introducing a backward incompatible change.
Note 4: A further enhancement would be to move presentation-related munging (like calling .title()
and/or capfirst()
in view code) from views to templates if/when #5972 gets committed but meanwhile this fix can solve this bug now with the tools we have at hand now.
Several of the problems exposed above had already been reported in #9273.
Attachments (7)
Change History (34)
by , 16 years ago
Attachment: | 10436-app-name-translation-in-admin-r9998.diff added |
---|
comment:1 by , 16 years ago
Summary: | Application names i10n in the admin app broken → Application names i18n in the admin app broken |
---|
comment:2 by , 16 years ago
Triage Stage: | Unreviewed → Accepted |
---|
comment:3 by , 16 years ago
Cc: | added |
---|
comment:4 by , 16 years ago
Description: | modified (diff) |
---|
by , 16 years ago
Attachment: | 10436-app-name-translation-in-admin-r10283.diff added |
---|
Patch updated to trunk post-bulk-edit and post-r10234
comment:5 by , 16 years ago
Has patch: | set |
---|
by , 16 years ago
Attachment: | 10436-app-name-translation-in-admin-r10314.diff added |
---|
Patch with some fixes to the patch iself
by , 15 years ago
Attachment: | 10436-app-name-translation-in-admin-r11581.diff added |
---|
Patch updated to trunk as of r11581
comment:7 by , 15 years ago
Cc: | added |
---|
by , 15 years ago
Attachment: | 10436-app-name-translation-in-admin-r12157.diff added |
---|
Patch updated to r12157
comment:8 by , 15 years ago
milestone: | → 1.2 |
---|
comment:9 by , 15 years ago
milestone: | 1.2 → 1.3 |
---|
I know Adrian put that bit into the template, but other than that we've never officially supported translation of app names, and that's really a much larger problem which should be dealt with all in one go rather than piecemeal in tickets like this one. So I'm going to punt it to 1.3.
by , 15 years ago
Attachment: | 10436-app-name-translation-in-admin-r12676.diff added |
---|
comment:10 by , 14 years ago
milestone: | 1.3 → 1.4 |
---|
I agree with ubernostrum that this is part of a much larger problem. This needs at least a lot more discussion and therefore has now no chance to make it to 1.3.
comment:11 by , 14 years ago
I'm inclined to call this at least related to #3591, worked on in the app-loading GSoC branch.
comment:12 by , 14 years ago
Cc: | added |
---|
comment:13 by , 14 years ago
Severity: | → Normal |
---|---|
Type: | → New feature |
comment:14 by , 14 years ago
Easy pickings: | unset |
---|---|
Patch needs improvement: | set |
10436-app-name-translation-in-admin-r12676.diff fails to apply cleanly on to trunk
by , 13 years ago
Attachment: | 10436-app-name-translation-in-admin-r17377.diff added |
---|
Patch updated to trunk as of now
comment:16 by , 13 years ago
Patch needs improvement: | unset |
---|---|
UI/UX: | unset |
I've attached an update patch for review. I intend to commit it in a couple of days.
comment:18 by , 13 years ago
I'm not sure if that's the correct approach, there is no easy way to actually mark an app name for translation, so this would only be a work around at best, an anti-pattern at worst. In other words, I would have vetoed this approach, to be honest, in favor of the app class approach of #3591.
comment:20 by , 13 years ago
Resolution: | fixed |
---|---|
Status: | closed → reopened |
Type: | New feature → Bug |
comment:22 by , 12 years ago
I've started a discussion about this topic on the Django Developers google group. I would appreciate your opinions on how to keep this moving forward because I believe it has to be implemented some way as soon as possible but I don't want to make the wrong decisions.
https://groups.google.com/forum/?fromgroups=#!topic/django-developers/7f0gKen2ces
Thank you in advance.
comment:23 by , 12 years ago
Status: | reopened → new |
---|
comment:24 by , 11 years ago
Cc: | added |
---|
comment:25 by , 11 years ago
Resolution: | → fixed |
---|---|
Status: | new → closed |
1.7 contains a proper solution to this issue, based on the app-loading refactor (#3951).
See also b80a8357d683b9a04a14ff46b1a132ad480e8a61.
comment:26 by , 11 years ago
Keywords: | app-loading added |
---|
(made description more clear)