Problem/Motivation
Lowercase action words are harder to translate. Many contributed modules, like Organic Groups and Views, already use uppercase action words.
Proposed Solution
In separate issues per module, make changes like this example, capitalizing action words:
+++ modules/block/block.admin.inc 1 Jan 2010 18:32:26 -0000
@@ -88,13 +88,13 @@ function block_admin_display_form($form,
$form[$key]['configure'] = array(
'#type' => 'link',
- '#title' => t('configure'),
+ '#title' => t('Configure'),
'#href' => 'admin/structure/block/manage/' . $block['module'] . '/' . $block['delta'] . '/configure',
);
if ($block['module'] == 'block') {
$form[$key]['delete'] = array(
'#type' => 'link',
- '#title' => t('delete'),
+ '#title' => t('Delete'),
'#href' => 'admin/structure/block/manage/' . $block['module'] . '/' . $block['delta'] . '/delete',
);
Remaining tasks
- Decide if this issue should also deal with short sentences, and if so, add examples.
The previous submitted patch does not longer apply.
Rob Loach suggested to split the issue on a module by module base.
So we need patches for these areas/strings/modules. See the separated issues:
- need issue for the main edit, delete, etc patch, or make sure it goes into issues below
- #1784738: Standardize capitalization on actions, in content_types: 'manage fields', 'manage display', 'edit', 'delete'
- #1784776: Standardize capitalization on actions and short sentences [manage display]
- #1784768: Standardize capitalization on actions and short sentences [remove items]
- #1784784: Standardize capitalization on actions, in aggregator: 'update items', 'remove items'
- #1784806: Standardize capitalization on actions in book: 'edit order and titles'
- #1784812: Standardize capitalization on actions in language date time: 'reset'
- #1784846: Standardize capitalization on actions in operations in shortcut: 'list links', 'edit set', 'delete set', 'edit, 'delete'
- #1785002: Standardize capitalization on actions in menu: 'edit menu', 'reset'
- #1785006: Standardize capitalization on actions for menu operations: 'add link', 'edit menu', 'delete menu', 'edit', 'delete', 'reset'
- #1785012: Standardize capitalization on actions for node operations: 'revert', 'view', 'edit', 'translate', 'delete'
- #1785018: Standardize capitalization on actions and short sentences [add translation]
- #1785024: Standardize capitalization on actions and short sentences [edit role]
- #1785038: Standardize capitalization on actions in user admin: 'edit permissions', 'edit role', 'edit', 'translate', 'view', 'cancel'
- #1785044: Standardize capitalization on actions for 'locked'
- #1496418: Views: Don't change capitalization of translatable strings with CSS
- #1913958: Bartik theme: Don't change capitalization of translatable strings with CSS
- #1914220: Standardize capitalization in watchdog: 'debug', 'error', 'alert', etc.
- #1919258: Remove < and > from menu select for consistency
- #2004246: Standardize capitalization on actions for comment operations: 'edit', 'translations', 'delete', 'reply', 'approve'
- #2002246: Capitalize operations links in the comment and taxonomy term admin UI
(a follow-up)
Original report by Dave Reid
There are a lot of table 'operations' that use lower case like 'edit' and 'delete' but we don't use lowercase action words in buttons. I've heard from a couple of translators that these lowercase short action words are harder to translate. Many major contrib modules are also using propercase action words, like Organic Groups and Views.
| Comment | File | Size | Author |
|---|---|---|---|
| #15 | 421118-propercase-round-one-D7.patch | 46.76 KB | dave reid |
| #14 | 421118-propercase-edit-delete-D7.patch | 46.19 KB | dave reid |
| #13 | screenshot_024.png | 70.49 KB | dave reid |
| #13 | screenshot_023.png | 76.27 KB | dave reid |
| #12 | 421118-propercase-edit-delete-D7.patch | 37.85 KB | dave reid |
Comments
Comment #1
dave reidInitial patch to see if I got everything for the testing bot.
Comment #3
keith.smith commentedOh, yes please.
I remember being happy with things being lowercase in Drupal 4.7; now my tastes have changed, for some reason.
I do note some changes like this that may slightly be out of scope:
And, if we're changing that, IMO, it should be "The default file size limit must be a number greater than zero."
What lowercase things will this leave? "new", "updated", "published"? Is there a "promoted"?
Comment #4
dave reidQuick revision to hopefully pass all tests. Will answer #3 in just a little bit.
Comment #5
dave reidHere's the result of
grep -Rn -e "\$t(['\"][a-z]"after the patch that shows any line with t(x) where x is a lowercase letter.Comment #6
dave reid@keith.smith Yeah those lines you pointed out I've split out into a separate patch so I don't try and scope creep at all.
The only change that is debatible in this latest page is related to the watchdog levels:
This way we're reusing the watchdog_severity_levels() instead of duplicating code.
Comment #8
robloachYeah, this has been one of my pet peeves with Drupal since forever.
Comment #9
sunTagging.
And, +1.
Comment #10
Bojhan commentedI cannot review this without pictures, or something atleast.
Comment #11
cburschkaThis patch does not apply at all anymore.
Comment #12
dave reidSmaller patch changing t('edit') to t('Edit') and t('delete') to t('Delete').
Comment #13
dave reidHere's the type of thing we're doing in #12.
Comment #14
dave reidExpanded #12 to include t('view'), t('never') and t('configure').
Comment #15
dave reidFixed tests.
Comment #16
robloachI greped through some operations and found some missing the sentence casing:
If we're just doing edit and delete in this round, however, I'd say this is RTBC.
Comment #17
robloachEdit, Delete, View, Never and Configure is a good first round. RTBCed..... Should we open up issues to battle the ones I listed above? Or hit them after this patch is committed?
Comment #18
dave reidI'd like to keep them in the same issue so whoever commits knows about the followups easily. Not like this issue is super-long right now anyway. :)
Comment #19
Bojhan commentedBefore we commit this I think its very reasonable to actually look at the design part of this. Other then, I like it better this way - I would really love this late in the release cycle that we are a bit more cautious with just marking things RTBC.
One of the aesthetic reasons I felt was that in terms of typography it implies importance, where as the actions are not the most important part in the table its the information holder this being a node title, role title ect. With that in mind, it translates to the user as a consistent artifact in Drupal core - where all actions in a table are lowercase.
I am not totally set on this, but I would like to have actual arguments why it would be better. Translations is not a valid argument in my eyes, as that would mean a lot of our sentences in core which heavily rely on the span of the English vocabulary should be changed.
Comment #20
dave reid@Bojhan: String freeze is apparently the 15th. We do not have a lot of time.
Comment #21
yoroy commentedCan't really make the case for lowercase actions, though I do remember we made a conscious decision to use lowercase then. I think uppercase is fine. For operations in tables it will help just that little bit in seperating each action from the others:
Vs.
Comment #22
webchickYou know...
The more I think about this, as much as I would love to do this, since this drives me absolutely bananas as well, it's the kind of patch that is going to lead to all sorts of follow-ups, re-rolls of other peoples' patches, etc. This is exactly the kind of stuff we should've been focusing on *before* 12/1, and instead this new initiative is coming within the last two weeks of the first alpha. :\
The translator argument is compelling, but it wasn't compelling enough to block the release of Drupal 5 & 6, so I can't see how it could block the release of 7.x.
Therefore, I'm sorry to do this, but I'm going to have to bump to 8.x.
Comment #23
yoroy commentedAll good, no kittens lost :)
Comment #24
dave reidWait...what??? If this was done sooner, there were much more major patches that would have all needed to be re-rolled. That's a much less serious of a situation now since we're nearing buxfix mode. Yes, this shouldn't block D7 release, but it also shouldn't be a reason to immediately disregard it.
Comment #25
dave reidI'd consider this in the same aspect as coding standard fixes. Are those not allowed after 1/15? Because you know that patches committed after that will have trailing whitespace, missing trailing commas in array definitions, etc.
Comment #26
webchickCoding standards fixes in core don't affect module developers. This does. They need to make changes to their UI strings to conform to core's standards which, for better or worse, have been consistent for the past 2 releases as lowercased. To be clear, it's not the act of having to re-roll patches that's problematic, it's the change in standard at this stage in the game.
It's also one of those patches where if there are any elements listed in #16 are missing, we must both postpone the time when we can tell translators to go ahead, and we add more things to the "must fix before release" queue, which is already at ~350 issues as it stands and we really don't need more of them. :(
Again, if this had been ready to go on 12/1, the deadline for major string/UI initiatives, things would've been different. The docs team was able to mount a huge initiative to change all help text in core by 12/1 to respect this deadline, for example. But I have to hold other patches to the same standard. Therefore, this feels pretty plainly like 8.x material to me. Restoring version.
Comment #27
dave reidOk, I can live with it. UX team has already agreed that the UX guidlines will be sentence case, so core will violate that standard for 7. I'm just frustrated that we don't have clear definitions about what our deadlines are allowing. No one on the UX team I talked to thought it wouldn't be ok for this. :/
Comment #28
webchickThe 15th is the deadline for finalizing the clean-up patches from the previous phase that are already in the queue. It's not the time for starting new initiatives, particularly when said initiatives are non-critical, will result in dozens of follow-up patches, and make modifications that affect module developers.
I tried to clarify this here as well: http://webchick.net/node/73#comment-1312
In short, we've had over 3 months since feature freeze to perform clean-up work like this. The point of an alpha is to move us toward release, not further polishing. So if a patch isn't one of the ones that's been lingering at RTBC since December, or one that fixes critical bugs, let's address it in D8 imo.
Comment #29
yoroy commentedLets do this.
Comment #30
dries commentedI'm OK with this patch but it doesn't quite apply anymore. Setting this back to 'Needs work'. Hopefully someone will be able to take a crack at this again. Thanks in advance.
Comment #31
dave reidCool, I can start a local branch to re-do this shortly.
Comment #32
yoroy commentedConsensus on this being a good thing to do was there, is still there. I assume this is not complex but quite some grunt work and susceptible to rerolls? I'd love to see this move forward without becoming frustrating to do :)
Comment #33
xjmMarked #364381: Capitalize strings wherever required as duplicate.
Comment #34
robloachWe should probably split the issue into maybe something like this to make it manageable:
Comment #35
dave reidI'm fine with a module-by-module basis.
I'm not fine with ridiculous tags.Comment #35.0
dbazuin commentedEdit the summary
Comment #35.1
dbazuin commentedEdit summary
Comment #35.2
dbazuin commentedEdit summary
Comment #35.3
dbazuin commentededit summary
Comment #35.4
dbazuin commentedEdit summary
Comment #35.5
dbazuin commentedEdit summary
Comment #35.6
dbazuin commentedEdit summary
Comment #35.7
dbazuin commentedEdit summary
Comment #35.8
dbazuin commentedEdit summary
Comment #35.9
dbazuin commentedEdit summary
Comment #35.10
dbazuin commentedadd link
Comment #35.11
dbazuin commentedadd link
Comment #35.12
dbazuin commentedadd link
Comment #35.13
dbazuin commentedadd link
Comment #35.14
dbazuin commentedadd link
Comment #35.15
dbazuin commentedadd link
Comment #35.16
dbazuin commentededit summary
Comment #35.17
dbazuin commentedadd link
Comment #35.18
dbazuin commentedadd link
Comment #35.19
dbazuin commentedadd link
Comment #35.20
dbazuin commentedadd link
Comment #35.21
dbazuin commentedadd links
Comment #36
hass commentedNeeds backport for #1496418: Views: Don't change capitalization of translatable strings with CSS and tons of other already fixed modules.
Comment #37
xjmThis is absolutely not backportable since it changes dozens of strings.
Comment #40
hass commentedAs translator I can only confirm this. This needs a backport for translators.
Comment #41
xjmNot sure what is going on with the tags.
Comment #42
xjmAlright, while I understand the current behavior is frustrating for translators, D7 has been out for nearly 22 months. Most of these strings have already been translated to their lowercase versions despite the frustration. Backporting it now would instead cause sites upgrading to see all their short links and buttons in a foreign language, and that's way worse.
So we will fix it in D8. This is a safe task to do during D8 code freeze; it just needs to be completely done before string freeze.
Comment #42.0
xjmtext correction
Comment #43
yesct commentedTook a look at the previous patch and it seems like it's doing a lot of changes of edit -> Edit, delete -> Delete, view -> View, configure -> Configure and those are the kind of action word changes.
But it does not have changes to "short sentences", are there examples of how changes to use short sentences should be make, or should this just focus on the action words?
Comment #43.0
yesct commentedLinking issues using [#ISSUENUM] syntax
Comment #43.1
yesct commentedadded example, and re-worded to be more clear.
Comment #43.2
yesct commentedtypo
Comment #43.3
yesct commentedsmall typo
Comment #43.4
hass commentedUpdated issue summary.
Comment #44
hass commentedAdded:
Comment #45
yesct commentedchanging title to take out the task of changing short sentences, because it's not clear what that is intended to do, and there is no example suggested yet.
In the separate issues,
what exactly should we be changing?
Just
t('edit') t('delete')
t('view'), t('never') and t('configure').
Plus, any word in the operations (drop buttons)?
Like #1784738: Standardize capitalization on actions, in content_types: 'manage fields', 'manage display', 'edit', 'delete' has t('manage fields')
Wait, I have another confusion. The issue summary says the separate issues are for the separate modules... but they kind of look like those sub issues are instead for the strings in the brackets. So, the separate issues were not created for the list in #34, but instead for the missing strings in #16
One problem, is that means, that the edit, delete, view, configure that there was wide agreement on, does not have a sub issue.
Even if we made sub issues for the list in #34, I dont think those are strickly modules, but maybe instead, areas in the UI, which multiple modules might contribute operations to. (I'm thinking translate is a node operation added by the content translation module.)
Suggestion
Lets get new issues opened up for the first two things in the list in #34 and start there.
ps. where is never an action word?
aggregator...
user admin
so yeah, we need screenshots. this is confusing.
Comment #46
hass commentedWe are changing to Delete, Edit, Manage fields and so on. There is nothing confusing in here.
Comment #46.0
hass commentedUpdated issue summary.
Comment #46.1
yesct commentedto reflect changes in issues needed.
Comment #46.2
yesct commentedUpdated issue summary, sub issue information
Comment #47
yesct commentedLets work on the various areas to get a feel for how to split this stuff up.
I tried to group things together already.
the issues really need screenshots.
For some to focus efforts on, lets try
#1785012: Standardize capitalization on actions for node operations: 'revert', 'view', 'edit', 'translate', 'delete'
#1784738: Standardize capitalization on actions, in content_types: 'manage fields', 'manage display', 'edit', 'delete'
and.. #1914220: Standardize capitalization in watchdog: 'debug', 'error', 'alert', etc.
Comment #48
yesct commentedWill we do changes to selects as part of the other open issues?
I think:
a) it would slow those issues down, and that changes to selects be separate issues, or
b) at least we get agreement here that changes to selects is A Good Thing.
I suggest a)
For example see:
#1785006-12: Standardize capitalization on actions for menu operations: 'add link', 'edit menu', 'delete menu', 'edit', 'delete', 'reset'
Changing menu name from <Administration> to - Administration -, alternate suggestion made to use brackets: [ ]
and
#1784806-11: Standardize capitalization on actions in book: 'edit order and titles'
which was missed when #1317884: Remove all instances of <none>, <Hidden> and <br/> from translatable strings because they lead to import errors happened.
As can be seen, there might need separate discussion and ui review on select changes.
Comment #48.0
yesct commentedUpdated issue summary, added watchdog issue.
Comment #49
yesct commentedadded separate issue to handle < and > found in select #1919258: Remove < and > from menu select for consistency
Comment #50
hass commentedI feel like removing the word "actions" from title and make this case a full core review about single word/short sentences as noted in summary...
Comment #51
hass commentedWe should followup with larger patches now. Creating patches per module may take months for this trivial changes. E.g. Full modules folder in one patch, includes folder in one and so on.
Comment #51.0
hass commentedadding follow-up issue
Comment #52
hass commentedWe need to decide if we do #1933082: Add context to short action names, too.
Comment #53
yesct commentedI think we need an issue to change the action words in the views ui.
See for example 9. the view in #1938576-1: Tags and Language setting not discoverable under "edit view name/description" button and #12
when the issue is created, add it to the issue summary and make a comment saying it was created and the summary was updated.
Comment #53.0
yesct commentedhighlighting the remaining task.
Comment #53.1
chrishks commentedAdded link to #2004246 as sub-task
Comment #54
mikeryanComment #63
pameeela commentedAll of the tasks in the IS are fixed so closing this.