Content Types Help and Descriptions

jeffschuler - September 15, 2009 - 19:23
Project:Case Tracker
Version:6.x-1.x-dev
Component:User interface
Category:bug report
Priority:normal
Assigned:Unassigned
Status:needs review
Description

Editing a Case node instructs: "Open a new case assigned to a particular project." at the top of the edit screen. This help text is obviously geared toward creating a new Case, and not appropriate when Editing.

The Case Content Type's help and description text, (set in casetracker_basic_node_info(),) match. This is so for the Project Content Type too.

help can probably be removed and left to the administrator to provide, and description should be something more general: "a brief description of the node type," as hook_node_info() docs suggest.

#1

jmiccolis - October 26, 2009 - 02:32
Status:active» needs review

Attached it a first stab at improving this. Feedback is welcome.

AttachmentSize
578350_2009_10_25.patch 1.34 KB

#2

jeffschuler - October 26, 2009 - 23:31

Thanks for looking into this!

Some suggestions:

+++ casetracker_basic.module 26 Oct 2009 02:30:34 -0000
@@ -21,15 +21,13 @@
+      'description' => t('A project, which contains cases, is suited for use to record information about a set of tasks, for example "Website improvements".'),

Seems kind of wordy. How about:
A project, which contains Cases, is a group of related tasks. For example: "Website improvements."

+++ casetracker_basic.module 26 Oct 2009 02:30:34 -0000
@@ -21,15 +21,13 @@
+      'description' => t('A case, which tracks the status of a task and is assigned to a particular project.'),

What if we made this into a complete sentence, as the first one is:
A case tracks the status of a task, and is part of a project.

Thanks!

--
I'm on crack. Are you, too?

#3

jmiccolis - October 27, 2009 - 02:22

"What if we made this into a complete sentence" lol, yea point taken.

So I'm modeling these descriptions off of what's in core for page and story. For example "A story, similar in form to a page, is ideal for creating and displaying content that informs or engages website visitors. Press releases, site announcements, and informal blog-like entries may all be created with a story entry. By default, a story entry is automatically featured on the site's initial home page, and provides the ability to post comments."

 
 

Drupal is a registered trademark of Dries Buytaert.