Link from "Recommended for 6.x", "Development snapshot", etc. in release table to explanation
| Project: | Drupal.org infrastructure |
| Component: | Drupal.org theme |
| Category: | feature request |
| Priority: | normal |
| Assigned: | Unassigned |
| Status: | needs review |
Jump to:
Several people have complained about the new red coloring and/or red error icon on development snapshots in project release download tables. While I think they are fine, we might be better off if we can make it more clear to users why these releases are made to look scary.
One idea would be to change the "Development snapshot" text in the Status column of the table into a link. We might consider doing the same for "Recommended" and "Supported". We'd want to allow site administrators to point these where they please (eg. to a handbook on d.o that explains in more detail what these statuses mean).
I think this could be done just in the theming layer right now, so doing that on d.o itself is one option. In fact, it might be the best option. But we could also add support for this into project releases directly.
Any thoughts?
#1
I'm planning to fix #230763: Inaccurate release table image captions by means of a theme function that lets you return whatever text you want, both for the thing displayed in the table, and the stuff to put in the title/alt attributes. So yeah, once I finish that patch, we could modify bluebeach to change these texts to include a handbook link of some kind, sure.
#2
This can now be altered in bluebeach if we want. Someone just has to either write the handbook page to link to, or find the right existing page/anchor in the handbooks.
#3
[edit: comments about red x icon moved to new issue]
#4
@JohnForsythe: I think that should be the topic of another issue. This issue is simply about linking the text in the table to a handbook page on d.o.
#5
I've edited the handbook page at http://drupal.org/handbook/cvs/releases/types and I think these descriptions do a pretty good job of explaining the various release types.
If people think this is a good page to use, here's some code to override the theme functions. I'm not sure if bluebeach uses the bluebeach_function_name() or phptemplate_function_name() format, but that's easy to change.
<?php
/**
* Return the message text for recommended releases in the download table.
*
* @param $release
* Object with data about the release.
* @param $text_type
* What kind of text to render. Can be either 'summary' for the summary
* text to include directly on the project node, or 'message' for the text
* to put in the title and alt attributes of the icon.
*/
function bluebeach_project_release_download_text_recommended($release, $text_type) {
if ($text_type == 'summary') {
return l(t('Recommended for %api_term_name', array('%api_term_name' => $release->api_term_name), '/handbook/cvs/releases/types#recommended'));
}
return t('This is currently the recommended release for @api_term_name.', array('@api_term_name' => $release->api_term_name));
}
/**
* Return the message text for supported releases in the download table.
*
* @see theme_project_release_download_text_recommended
*/
function bluebeach_project_release_download_text_supported($release, $text_type) {
if ($text_type == 'summary') {
return l(t('Supported for %api_term_name', array('%api_term_name' => $release->api_term_name), '/handbook/cvs/releases/types#supported'));
}
return t('This release is supported but is not currently the recommended release for @api_term_name.', array('@api_term_name' => $release->api_term_name));
}
/**
* Return the message text for snapshot releases in the download table.
*
* @see theme_project_release_download_text_recommended
*/
function bluebeach_project_release_download_text_snapshot($release, $text_type) {
if ($text_type == 'summary') {
return l(t('Development snapshot'), '/handbook/cvs/releases/types#snapshot');
}
return t('Development snapshots are automatically regenerated and their contents can frequently change, so they are not recommended for production use.');
}
/**
* Return the message text for snapshot releases in the download table.
*
* @see theme_project_release_download_text_recommended
*/
function bluebeach_project_release_download_text_unsupported($release, $text_type) {
if ($text_type == 'summary') {
return l(t('Unsupported'), '/handbook/cvs/releases/types#unsupported');
}
return t('This release is not supported and may no longer work.');
}
?>
#6
#7
subscribe