Come together with the global Drupal community in Rotterdam, 28 Sept – 1 Oct 2026. Sessions, contribution, connection, and Early Bird savings until 8 June.Currently, 95% of help texts end with (as an example):
$output .= '<p>' .t('For more information please read the configuration and customization handbook <a href="@aggregator">Aggregator page</a>.', array('@aggregator' => 'http://drupal.org/handbook/modules/aggregator/')) .'</p>';
The attached patch modifies this, for all core modules, to (as an example):
$output .= '<p>' .t('For more information, please read the online handbook\'s <a href="@aggregator">aggregator module page</a>.', array('@aggregator' => 'http://drupal.org/handbook/modules/aggregator/')) .'</p>';
I'm leaving this at CNW although feel free to comment. http://drupal.org/node/197297 sets a few missing lines to the old standard, which is appropriate for that patch. When/if it is committed, this one will have to have a small re-roll.
| Comment | File | Size | Author |
|---|---|---|---|
| #2 | help-tag-lines-2.patch | 66.44 KB | keith.smith |
| help-tag-line.patch | 56.97 KB | keith.smith |
Comments
Comment #1
keith.smith commentedNote that this page I just now (!!) found specifies:
Currently the majority of these pages read as:
Contrary to my initial post, I think it would be simpler and easier to scan if the phrase read:
where the first letter of Modulename is capitalized. Note that nicely avoids a use of an apostrophe that would have to be quoted.
I am not sure what the process should be for proposing an amendment to http://drupal.org/node/24566. I can edit the page, but obviously would not do so without an issue to point to. It would be nice to do all this in the same issue. I have not yet (but will) rolled a patch for the relevant parts of the actual help text.
Comment #2
keith.smith commentedPatch implementing the above attached. If this is committed, I will be happy to edit the specification page accordingly, linking to this issue.
Comment #3
keith.smith commentedOr, alternatively, it would be simple enough to pass the module name and handbook link to a small private helper function in help module, and let it construct this string. Obvious benefit would be that we'd could edit this in one place, and that presumably, translators would only have to deal with the biggest part of this string once.
Comment #4
gábor hojtsy- New text looks better. That standard was set previously because that part of the handbooks was actually called the "configuration and customization handbook". You can notice that there are actually more then one handbook http://drupal.org/handbooks :) and this was the title. Now this part is called the Getting started guide. As any kind of reorganization might be possible later, I'd suggest not wiring in the handbook name.
- Programmatic generation has the advantage that the main string only needs to be translated once, but then depending on the replaced part (module name) some language might need to use different verb forms, or whatever. Thinking about this a bit, having these strings separate, translators can also add pointers to information in their (localized) language, so centralizing this, they would loose the ability. (Although I am not sure any language team does this now).
So all this said, I committed the latest patch. It had a failed hunk in color module, which I fixed, and it had Openid instead of OpenID, which was also fixed. Thanks again!
Comment #5
keith.smith commentedI've modified the relevant bullet point on http://drupal.org/node/24566 to update to this new specification, with a log message referencing this issue.
Thanks Gábor!
Comment #6
(not verified) commentedAutomatically closed -- issue fixed for two weeks with no activity.