[drupal-devel] [feature] More improvements to forum help language

[Morbus Iff]

Issue status update for http://drupal.org/node/18732

 Project:      Drupal
 Version:      cvs
 Component:    forum.module
 Category:     feature requests
 Priority:     normal
-Assigned to:  Anonymous
+Assigned to:  Morbus Iff
 Reported by:  nysus
 Updated by:   Morbus Iff
 Status:       patch
 Attachment:   http://drupal.org/files/issues/06_forumhelp.patch (2.62 KB)

Repatched to HEAD.


Morbus Iff



Previous comments:
------------------------------------------------------------------------

March 11, 2005 - 08:33 : nysus

Attachment: http://drupal.org/files/issues/forum_7.patch (2.45 KB)

Here's some more langauge improvements to the forum help text in the
forum_help() function for the following Drupal pages:
'admin/forum': Got rid of technical jargon and improved readability and
flow of sentences.
'admin/forum/add/container': added a concrete example for additional
clarification
'admin/forum/add/forum': Got rid of technical jargo, improved
readability and flow of sentences, added a  concrete example for
additional clarification.


------------------------------------------------------------------------

March 11, 2005 - 09:08 : Morbus Iff

I'm on the fence so I have to -1. I'd +1 it with some of the revisions
below:
* Never use location in documentation or help instructions. The stuff
may be "below" or "above" your help text now, but that doesn't mean it
is always going to be like that (ie. prevent the possibility of future
"incorrect" documentation). 
* You use [p /]. That's bad HTML. A [p] is a container tag, and thus,
should really contain something. I'd revise the text to be just one
paragraph, as I'm not really a fan of [br /][br /] either.
* "To delete a forum or container choose the appropriate "edit"
operation." requires a comma.
* You didn't do a spellcheck. What's "apporpriate"?
* For add/container, it's either "fora" or "forums". "Forum" is not an
adequate plural in this context.
* I'd include the word "root" in quotes to distinguish that it's a
"term" the user may not be familiar with.
* I don't like the use of the word "many". It's extraneous, not
finitely defined, and ultimately garbage.
* I don't like the use of "something in common". I may just want a
place for people to create crap without interfering with the front page
of my site. "Miscellany" or "potpourri" is not "something in common".
The use of "similar" in the original text is stronger, and your "For
example" removes the need for "something in common".
* What's a "forum area"?


------------------------------------------------------------------------

March 12, 2005 - 10:07 : nysus

After some thought, most of these changes were made.  However, I kept
the two paragraph structure and surrounded each paragraph with >p>>/p>
tags.  The paragraphs cover quite quite different main ideas and I
think it's helpful to convey this to users by indicating such with
two-paragraph structure.


------------------------------------------------------------------------

March 12, 2005 - 10:08 : nysus

Attachment: http://drupal.org/files/issues/forum_8.patch (2.36 KB)

Damn, submitted without attaching again.  Here's the revision.


------------------------------------------------------------------------

March 12, 2005 - 10:39 : Morbus Iff

I didn't catch this the first time, but "A forum holds threaded topic
discussions" should be thought about. The act of threading is a UI
issue, and one that the administrator can turn off or disable (or, even
the user with the Comment Options box). Other than that little qualm,
I'm for it. +1.


------------------------------------------------------------------------

March 23, 2005 - 16:39 : Dries

This patch does not seem to apply.