[drupal-devel] Improvements abandoned?
I submitted a couple of patches a few months ago to improve some of Drupal's help text. See: http://drupal.org/node/31394 http://drupal.org/node/27073 Why the delay? These patches probably won't even apply now. Please hit me with a clue bat if my complaint here is out of line. -- Dondley Communications http://www.dondleycommunications.com Communicate or Die: American Labor Unions and the Internet http://www.communicateordie.com
Steve Dondley wrote:
I submitted a couple of patches a few months ago to improve some of Drupal's help text. See:
http://drupal.org/node/31394 http://drupal.org/node/27073
Why the delay? These patches probably won't even apply now.
See cel4145's comment on #31394. The reason is that (*very soon now* I hope :P) the help text for each module will be automatically generated from its handbook page in http://www.drupal.org/handbook/modules/ Therefore, these should probably be submitted as documentation issues instead. If they make sense to be placed on the "jump off page" for the given modules, they can be put there and will be included, else they can be sub-pages off the module which a user will see when they click on the link at the bottom of its admin/help page.
Can you clarify for me what "help text" is? The link you cite seems to be for "documentation" which in my view is quite different from "help text." I'm calling "help text" the little helpful blurbs that appear inline with the administration pages. That's what my patches improve. On 10/10/05, Angie Byron <drupal-devel@webchick.net> wrote:
Steve Dondley wrote:
I submitted a couple of patches a few months ago to improve some of Drupal's help text. See:
http://drupal.org/node/31394 http://drupal.org/node/27073
Why the delay? These patches probably won't even apply now.
See cel4145's comment on #31394.
The reason is that (*very soon now* I hope :P) the help text for each module will be automatically generated from its handbook page in http://www.drupal.org/handbook/modules/
Therefore, these should probably be submitted as documentation issues instead. If they make sense to be placed on the "jump off page" for the given modules, they can be put there and will be included, else they can be sub-pages off the module which a user will see when they click on the link at the bottom of its admin/help page.
-- Dondley Communications http://www.dondleycommunications.com Communicate or Die: American Labor Unions and the Internet http://www.communicateordie.com
Steve Dondley wrote:
Can you clarify for me what "help text" is? The link you cite seems to be for "documentation" which in my view is quite different from "help text."
Sure. The text displayed at: http://drupal.org/handbook/modules/aggregator will be identical to what's displayed in: http://www.example.org/admin/help/aggregator With the exception that the bottom of admin/help/aggregator will also contain a link back to the aggregator handbook page. It is here where users can find pages about additional features, use cases, etc. that don't fit into the typical "template" help pages for all modules (in this case, "Configuring news feeds," "Creating categories in the aggregator," etc.). However, in looking at the patches more closely, you're right that they are not dealing with admin/help#modulename but more with the 'descriptive' text above certain sections. So I guess I can't tell you why they're not being implemented, sorry! :)
At 11:28 PM -0400 10/10/05, Angie Byron wrote:
The reason is that (*very soon now* I hope :P) the help text for each module will be automatically generated from its handbook page in http://www.drupal.org/handbook/modules/
Isn't this backwards? Shouldn't the handbook be generated by pulling the help text of the modules? If I ever become a module developer I want to be able to maintain all the content for my module through CVS. I wouldn't want to have to log issues against documentation in order to update the help text in my module!! ...R.
On Tue, 11 Oct 2005, Richard Archer wrote:
At 11:28 PM -0400 10/10/05, Angie Byron wrote:
The reason is that (*very soon now* I hope :P) the help text for each module will be automatically generated from its handbook page in http://www.drupal.org/handbook/modules/
Isn't this backwards? Shouldn't the handbook be generated by pulling the help text of the modules?
If I ever become a module developer I want to be able to maintain all the content for my module through CVS. I wouldn't want to have to log issues against documentation in order to update the help text in my module!!
I think this mainly applies to the core modules. Also, many developers aren't particularly fond of (or good at) writing help texts and will be glad to have somebody else doing it for them. :p As I see it the texts themselves would still end up in cvs. Cheers, Gerhard
participants (4)
-
Angie Byron -
Gerhard Killesreiter -
Richard Archer -
Steve Dondley