Skip to:
Content

bbPress.org

Opened 10 years ago

Closed 10 years ago

#1510 closed defect (fixed)

Contextual help on Dashboard plugin screens

Reported by: ryanimel Owned by: ryanimel
Milestone: 2.0 Priority: normal
Severity: minor Version:
Component: General - Administration Keywords: has-patch
Cc:

Description

Okay, this one's far from sexy. Each screen of the plugin should have its own help text (toggled via tab on upper right).

Would need help text for:

  • Forum settings
  • Add new/edit Forum
  • Add new/edit Topic
  • Add new/edit Reply

Adding the help text to the custom post type screen is simple enough, example here: http://codex.wordpress.org/Function_Reference/register_post_type#Example

I've never added contextual help to a plugin settings screen before, but should be just as easy. "Difficult" part will be writing the help text itself.

I'm happy to own it, and will get stuff submitted for it soon. But if anyone else feels like piling on, feel free.

Attachments (1)

bbpress_contextual_help.diff (23.9 KB) - added by ryanimel 10 years ago.
Adds contextual help to each bbPress screen (settings, topic, reply, forum, topic tags)

Download all attachments as: .zip

Change History (6)

#1 @johnjamesjacoby
10 years ago

  • Keywords has-patch added
  • Milestone changed from Plugin - Future Release to Plugin
  • Type changed from enhancement to defect
  • Version 1.0.1 deleted

Adjusting milestone/version/type.

Last edited 10 years ago by johnjamesjacoby (previous) (diff)

#2 @ryanimel
10 years ago

@johnjamesjacoby: Hey John, is there any plan to bring the bbPress site documentation area up to date? Would be happy to help with that as well. While writing some of this contextual help for the plugin, seeing it would be nice to have additional help pages to link to for further help/explanation.

For now I'll just keep track of any doc pages it would be nice to add, and get about writing them as soon as I can.

@ryanimel
10 years ago

Adds contextual help to each bbPress screen (settings, topic, reply, forum, topic tags)

#3 @ryanimel
10 years ago

Attached a patch that is a first pass at contextual help for these screens. I addressed the screens listed in the ticket description, as well as the topic tags screen. In each case I tried to stick to WordPress' own help text standards, relying on the appropriate help text templates when I could (add new post for add new forum/reply/topic, etc.). Hopefully this should keep the number of rewrites down to a minimum.

As far as the help text itself, I would ask that my explanations be reviewed/revised for:

  • Forum attributes (both on the list of forums screen and the add new/edit forum screen)
  • The spam action on topic/reply list screens

I _think_ everything else should be good to go, though. Hope it helps!

#4 @johnjamesjacoby
10 years ago

Awesome. Will comb through these today. Thanks a bunch!

#5 @johnjamesjacoby
10 years ago

  • Resolution set to fixed
  • Status changed from new to closed

(In [3119]) Add contextual help to forums, topics, replies, and settings. Fixes #1510. Props ryanimel for original patch.

Note: See TracTickets for help on using tickets.