[drupal-devel] [task] Improve story help texts

Goba drupal-devel at drupal.org
Sun Jan 16 20:13:29 UTC 2005

 Project:      Drupal
 Version:      cvs
 Component:    story.module
 Category:     tasks
 Priority:     normal
 Assigned to:  Bèr Kessels
 Reported by:  Bèr Kessels
 Updated by:   Goba
 Status:       patch

But having a multisentence long text being present two times in the
code, and even one more time as a prefix makes translation a lot
harder. True, the two identical strings only need to be translated
once, but not the third one. Who will spot that the longer one actually
has the same prefix? Programs like kbabel provide no clue on what else
is in the file, they only concentrate on one string.

Also if one fixes a typo in your string, or starts to improve it, he
needs to do so in three places, and the translator also needs to fix it
in two places. I bet non-coders will not expect that a string they see
on the interface might be in the code three times, so if they fix one
instance, it might not be that one exact instance they expected to fix.
Non-coders have probably no idea on what the section identifiers mean...


Previous comments:

January 7, 2005 - 14:19 : Bèr Kessels

Attachment: http://drupal.org/files/issues/story_help.patch (3.06 KB)

Because of historical reasons the story module help contained all sortts
of odd texts, that are partly even untrue.

This patch changes the help so that it:
* stresses that stories are nodes in their simplest form
* removes all the bloat about workflow. workflow can be configured for
any node type, why should nstories mention it?
* removes parts of voting, queues, promotion, comments etc. Any node
type can have this. 
* adds a note that you can use stories for personal blogging, and as
general pages, pages with no specific purpose (I consider, for example,
a forum node a node with a special purpose)
* stresses that you should use other modules (taxonnomy, menu) to give
the node a place on your site. 

set to CVS but will apply to 4.5 too.....


January 10, 2005 - 17:41 : Bèr Kessels

Attachment: http://drupal.org/files/issues/story_help_0.patch (3.06 KB)

previous patch was the one before spellchecking. This one is without the
two spelling errors.


January 10, 2005 - 20:29 : Dries

Can someone review this please?


January 12, 2005 - 14:53 : Bèr Kessels

Attachment: http://drupal.org/files/issues/story_help_1.patch (3.01 KB)

After some discussion on the drupal-docs ML, i came up with the
following help-texts:

Stories are articles in their simplest form: they have a title, a 
teaser and a body, but can be extended by other modules. The teaser is

part of the body too. Stories may be used as a personal blog or for

Stories are articles in their simplest form: they have a title, a 
teaser and a body, but can be extended by other modules. The teaser is

part of the body too. Stories may be used as a personal blog or for
articles. By default, no menu item, or navigation element is  
created for a story.  An extra feature of a  
story is, that an administrator can specify a submission guideline and 

enforce a minimum word count for user submitted stories


January 13, 2005 - 20:42 : Dries

This patch doesn't apply against HEAD.

patching file modules/story.module
Hunk #1 FAILED at 14.
Hunk #2 FAILED at 26.
2 out of 2 hunks FAILED -- saving rejects to file


January 14, 2005 - 23:55 : Bèr Kessels

AARHGH, such a simple patch, so much hassle. My mistake, uplaoded the
wrong one again.

This one should be right.


January 15, 2005 - 00:05 : Bèr Kessels

Attachment: http://drupal.org/files/issues/story_improve_help.patch (3.19 KB)



January 15, 2005 - 09:01 : Dries

Committed to HEAD.


January 15, 2005 - 20:10 : Goba

Attachment: http://drupal.org/files/issues/Drupal.simplify.story.help.patch (2.18 KB)

Well, this was a bogus fix after all. The patch removed the paragraph
tags used in some help texts. These were introduced lately in most of
the help texts to improve consistency in displaying help texts. I am
unsure however, whether such paragraphs are going to be used on node
add pages...

What is worse, that the committed patch contained the exact same
sentence sequeces three times in the code, two times identical, one
time with an extension. Being in a switch() statement, it is quite
simple to overcome the duplicate, and it is also not hard to watch out
for the extended part. A patch attached to remedy this.

BUT this still does not restore the paragpraph wrapping around the help
text in the admin helps, since I am unsure, whether that would be
applicable to the 'node add' page descriptions.


January 16, 2005 - 21:07 : Bèr Kessels

Allthough your patch cleans the code, I did purposedly not do it your
way. The reason being that i recall (but cannot refind some discussion
about this. AFAIKR it was decided we would keep help separate. The
reason being that non-codes would be able to chage the help of various
textx easier.

View: http://drupal.org/node/15264
Edit: http://drupal.org/project/comments/add/15264

More information about the drupal-devel mailing list