Improve story help texts [#15264]

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.....

Comment	File	Size	Author
#8	Drupal.simplify.story.help.patch	2.18 KB	Gábor Hojtsy
#8
#6	story_improve_help.patch	3.19 KB	Bèr Kessels
#6
#3	story_help_1.patch	3.01 KB	Bèr Kessels
#3
#1	story_help_0.patch	3.06 KB	Bèr Kessels
#1
	story_help.patch	3.06 KB	Bèr Kessels

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

Bèr Kessels CreditAttribution: Bèr Kessels commented 10 January 2005 at 16:41

File	Size
story_help_0.patch	3.06 KB

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

Comment #2

Dries CreditAttribution: Dries commented 10 January 2005 at 19:29

Can someone review this please?

Comment #3

Bèr Kessels CreditAttribution: Bèr Kessels commented 12 January 2005 at 13:53

File	Size
story_help_1.patch	3.01 KB

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

Short:
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 news
articles.

Longer:
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 news
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

Comment #4

Dries CreditAttribution: Dries commented 13 January 2005 at 19:42

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 modules/story.module.rej

Comment #5

Bèr Kessels CreditAttribution: Bèr Kessels commented 14 January 2005 at 22:55

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

This one should be right.

Comment #6

Bèr Kessels CreditAttribution: Bèr Kessels commented 14 January 2005 at 23:05

File	Size
story_improve_help.patch	3.19 KB

**sigh**

Comment #7

Dries CreditAttribution: Dries commented 15 January 2005 at 08:01

Committed to HEAD.

Comment #8

Gábor Hojtsy

he/him

Hungarian

Hungary

CreditAttribution: Gábor Hojtsy commented 15 January 2005 at 19:10

File	Size
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.

Comment #9

Bèr Kessels CreditAttribution: Bèr Kessels commented 16 January 2005 at 20:07

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.

Comment #10

Gábor Hojtsy

he/him

Hungarian

Hungary

CreditAttribution: Gábor Hojtsy commented 16 January 2005 at 20:13

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...