[wp-trac] [WordPress Trac] #23163: 3.6 Network Admin Help Text

[WordPress Trac]

#23163: 3.6 Network Admin Help Text
----------------------------+------------------
 Reporter:  DrewAPicture    |       Owner:
     Type:  task (blessed)  |      Status:  new
 Priority:  normal          |   Milestone:  3.6
Component:  Help/About      |     Version:
 Severity:  normal          |  Resolution:
 Keywords:  has-patch       |
----------------------------+------------------
Description changed by DrewAPicture:

Old description:

> One of the [http://make.wordpress.org/docs Doc team's] action items for
> 3.6 is to work on overhauling the Network Admin help tabs, many of which
> contain outdated and, well, unhelpful information.
>
> Our goals:
> * Focus on writing action vs description-based help text
> * Aim for a consistent voice
> * Pave the way for future Help UI changes in how we structure the
> information
>
> Any Network Admin screen is fair game but by no means do we intend to
> change strings just for the sake of change. It was the consensus of the
> team to focus on this effort earlier in the release cycle than usual so
> that translators will have plenty of time to work on new strings and
> provide feedback.

New description:

 One of the [http://make.wordpress.org/docs Doc team's] action items for
 3.6 is to work on overhauling the Network Admin help tabs, many of which
 contain outdated and, well, unhelpful information.

 Our goals:
 * Focus on writing action vs description-based help text
 * Aim for a consistent voice
 * Pave the way for future Help UI changes in how we structure the
 information

 Any Network Admin screen is fair game but by no means do we intend to
 change strings just for the sake of change. It was the consensus of the
 team to focus on this effort earlier in the release cycle than usual so
 that translators will have plenty of time to work on new strings and
 provide feedback.

 Following some [https://twitter.com/DrewAPicture/status/295248525699190785
 feedback] from @nacin, @markjaquith, and @aaroncampbell, it was decided
 the best format for concatenating help tabs strings should follow this
 format going forward:

 {{{
 $example_string = '<p>' . __( 'This is some help text' ) . '</p>';
 $example_string .= '<p>' . __( 'This is some more help text' ) . '</p>';

 get_current_screen()->add_help_tab( array(
 'id'    => 'example',
 'title' => __( 'Example' ),
 'content'       => $example_string
 ) );
 }}}

--

-- 
Ticket URL: <http://core.trac.wordpress.org/ticket/23163#comment:5>
WordPress Trac <http://core.trac.wordpress.org/>
WordPress blogging software