WordPress.org

Make WordPress Core

Opened 3 years ago

Closed 3 years ago

Last modified 3 years ago

#15376 closed task (blessed) (fixed)

Post formats help text

Reported by: nacin Owned by: andrea_r
Milestone: 3.1 Priority: normal
Severity: normal Version: 3.1
Component: Administration Keywords: has-patch
Focuses: Cc:

Description

If there's a UI visible, we need to show contextual help.

Attachments (3)

15376.patch (3.0 KB) - added by vegasgeek 3 years ago.
15376-2.patch (4.2 KB) - added by vegasgeek 3 years ago.
FormatsHelpReferMetabox.patch (764 bytes) - added by dougwrites 3 years ago.
@Nacin: This adds the generic help text to the Formats meta box, which just refers people to the help tab.

Download all attachments as: .zip

Change History (19)

comment:1 PeteMall3 years ago

  • Keywords needs-patch added
  • Owner set to andre_r
  • Status changed from new to assigned

comment:2 westi3 years ago

  • Owner changed from andre_r to andrea_r

comment:3 andrea_r3 years ago

  • Cc andrea_r added

vegasgeek3 years ago

comment:4 vegasgeek3 years ago

  • Cc vegasgeek added
  • Keywords has-patch added; needs-patch removed

comment:5 jane3 years ago

  • Version set to 3.1

Fine.

comment:6 PeteMall3 years ago

  • Keywords commit added; has-patch removed

comment:7 westi3 years ago

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

(In [16583]) Add Post formats info to the help text. Fixes #15376 props vegasgeek

comment:8 nacin3 years ago

This should probably say that your theme may support additional formats, rather than listing Aside and Gallery explicitly. Surely not everyone who seeks help from the tab will be using Twenty Ten.

A simple current_theme_supports should be able to handle hiding this when it is irrelevant, also.

Maybe a new paragraph with a bulleted list of the supported formats, per the Codex article? Otherwise someone using an 'Aside' will need yo test for themselves that it means no title.

comment:9 PeteMall3 years ago

  • Keywords needs-patch added; commit removed
  • Resolution fixed deleted
  • Status changed from closed to reopened

vegasgeek3 years ago

comment:10 vegasgeek3 years ago

  • Keywords has-patch added; needs-patch removed

Nacin, good call.

I rewrote the format bit in the publish section, added a conditional bit that shows what format types are available for the current theme and added a link to the documentation for post formats.

The other option would be to include the entire list of format types and their description (from the codex), but I'm thinking that may end up getting out of sync if one gets updated and not the other.

Thoughts?

comment:11 nacin3 years ago

I don't think it's crazy to include a simple sentence to describe each format supported, considering we're bulleting them here anyway. Linking to the Codex article (if current_theme_supports) makes sense too.

Cross referencing http://wordpress.org/support/topic/what-is-different-between-post-format-aside-and-status

comment:12 nacin3 years ago

Also, would want Jane to weigh in on the help text prior to re-patching, to confirm or reject my thoughts.

Aside from that, the patch will need to grab the formats, but then use the strings from get_post_format_strings(), to ensure they are properly translated.

comment:13 dougwrites3 years ago

  • Cc heymrpro@… added

comment:14 nacin3 years ago

Re: #15638, need help text in the meta box, like page attributes.

dougwrites3 years ago

@Nacin: This adds the generic help text to the Formats meta box, which just refers people to the help tab.

comment:15 nacin3 years ago

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

(In [16969]) Post formats help text. fixes #15376.

comment:16 nacin3 years ago

(In [16971]) Italicize. see #15376.

Note: See TracTickets for help on using tickets.