WordPress.org

Make WordPress Core

Opened 7 years ago

Closed 7 years ago

Last modified 7 years ago

#25837 closed defect (bug) (fixed)

Twenty Fourteen: add in contextual help for setting up Featured Content

Reported by: lancewillett Owned by:
Milestone: 3.8 Priority: high
Severity: normal Version: 3.8
Component: Bundled Theme Keywords:
Focuses: Cc:

Description

To help authors use the theme to its full potential, let's add in as much help and tips as we can.

Things like maybe on Posts list screen, add a help screen for how to feature posts and add featured images.

Then, in the Customizer where we have all the FC settings, let's use labels and help text as much as the UI allows.

Two most important items to educate, showcase, and help with are:

  1. Featured Content
  2. Featured Images

Attachments (7)

25837.diff (1.5 KB) - added by obenland 7 years ago.
25837.1.diff (1.6 KB) - added by obenland 7 years ago.
25837.2.diff (2.0 KB) - added by lancewillett 7 years ago.
Working from obenland's .1 patch, proper actions and better title and text
25837.3.diff (1.4 KB) - added by siobhan 7 years ago.
Updating theme description
25837.4.diff (4.1 KB) - added by siobhan 7 years ago.
Updates customizer text
25837.5.diff (2.7 KB) - added by siobhan 7 years ago.
Updates help text
25837.6.diff (2.1 KB) - added by obenland 7 years ago.
Limits Help tab to only "post" post type edit screen

Download all attachments as: .zip

Change History (54)

#1 @iamtakashi
7 years ago

  • Cc takashi@… added

#2 @RDall
7 years ago

  • Cc robert@… added

#3 follow-up: @lancewillett
7 years ago

It'd be cool to also develop visual tutorials, using images and video, to illustrate how to use the theme to its fullest potential. Maybe linking them in the contextual help, hosted on the Codex or somewhere on WP.org.

#4 @taupecat
7 years ago

  • Cc tracy@… added

#5 in reply to: ↑ 3 @rachelbaker
7 years ago

Replying to lancewillett:

It'd be cool to also develop visual tutorials, using images and video, to illustrate how to use the theme to its fullest potential. Maybe linking them in the contextual help, hosted on the Codex or somewhere on WP.org.

Also want to be sure to inform users that the background of the Twentyfourteen theme is only displayed on wide-screens, when they are in the Background page. Possibly through use of add_help_tab() to put text in the Help area. related #25869

#6 @rachelbaker
7 years ago

  • Cc rachel@… added

#7 @lancewillett
7 years ago

In 26045:

Twenty Fourteen: add brief inline help text for Featured Content controls in Customizer. See #25837.

#8 follow-up: @lancewillett
7 years ago

  • Keywords 2nd-opinion ui-feedback added

An idea: in the Customizer Featured Content pane, when we mention "featured" posts, link to that exact view: can we link from "featured" tag posts to their posts list?
/wp-admin/edit-tags.php?taxonomy=post_tag&post_type=post&s=featured

#9 in reply to: ↑ 8 ; follow-up: @iamtakashi
7 years ago

Replying to lancewillett:

An idea: in the Customizer Featured Content pane, when we mention "featured" posts, link to that exact view: can we link from "featured" tag posts to their posts list?
/wp-admin/edit-tags.php?taxonomy=post_tag&post_type=post&s=featured

I like the idea. Did you mean here?
/wp-admin/edit.php?tag=featured

#10 in reply to: ↑ 9 @lancewillett
7 years ago

Replying to iamtakashi:

Replying to lancewillett:

I like the idea. Did you mean here?
/wp-admin/edit.php?tag=featured

Yes, much better. :) Thank you.

#11 @iamtakashi
7 years ago

Just noting so that we don't forget. We probably should mention the maximum number of featured contents is six.

#12 @lancewillett
7 years ago

In 26092:

Twenty Fourteen: update the theme description with more information about theme features such as Featured Content and how to set it up. See #25837.

#13 @lancewillett
7 years ago

In 26101:

Twenty Fourteen: add in more contextual help for setting up Featured Content, links to "featured" tag posts and "sticky" posts from inside the Customizer. See #25837.

#14 follow-up: @taupecat
7 years ago

I'm looking into editing the content in the welcome panel, but can only find two ways of customizing it:

1) Replace the text that's currently in the welcome panel via jQuery.

or

2) Disable the welcome panel via an action hook and build a new one to include via an action hook.

Either solution seems rather extreme. Suggestions?

#15 in reply to: ↑ 14 @lancewillett
7 years ago

Replying to taupecat:

I'm looking into editing the content in the welcome panel, but can only find two ways of customizing it:
2) Disable the welcome panel via an action hook and build a new one to include via an action hook.

I agree it's a bit extreme to remove the default completely with the welcome_panel action, and with the big "Customize" link right there in the default Welcome screen, that'd be enough to get a new author into the Customizer and they'd discover Featured Content there.

A few ideas:

  1. Maybe with JavaScript change out the "More Actions" links to point to Featured Content and Featured Images setup? We'd need to make a Codex page for both (or point to existing).
  2. Could we add a Welcome-style screen to another admin page, like themes.php? I'm not sure how difficult that would be. If Twenty Fourteen is the active theme, show a message above the theme grid with specific instructions for Twenty Fourteen? Maybe dismissable and just one or two links (also to the Codex).

#16 @lancewillett
7 years ago

Tracking an idea celloexpressions mentioned, would be be allowed HTML in the theme description? To add in URLs to point to key editing pages. If not in style.css, maybe with a custom function override the description shown in themes.php to add in URLs.

#17 @lancewillett
7 years ago

For "Help" tab content, I think we should look at adding at least a line or URL or two to the following:

  1. Appearance > Themes: wp-admin/themes.php
  2. Edit Posts: wp-admin/edit.php

In there, mentioning the key things we mention in the Customizer pane:

  • Easily feature all posts with the "featured" tag [link in-admin] or a tag of your choice; if no posts match the tag, "sticky" posts [link in-admin] will be displayed instead.
  • Enhance your design with Featured Images [link to how-to article]

#18 @lancewillett
7 years ago

In 26135:

Twenty Fourteen: use numbered placeholders for Customizer help text in case they get swapped during translation, props obenland. See #25837.

@obenland
7 years ago

@obenland
7 years ago

#19 @obenland
7 years ago

  • Keywords has-patch added; needs-patch removed
  • Version set to trunk

#20 @nacin
7 years ago

There is not a dedicated hook for adding help tabs, but admin_head-$page would be most preferred.

@lancewillett
7 years ago

Working from obenland's .1 patch, proper actions and better title and text

#21 @lancewillett
7 years ago

In 26153:

Twenty Fourteen: first pass at adding help text to to "Help" tab for edit.php and themes.php screens. Props obenland for starter patch, see #25837.

#22 @obenland
7 years ago

Having it hooked into 'admin_head-edit.php' will also add it in the page list and any custom post type, as far as I can tell without testing (Mavericks mangled my sandbox). Intentionally?

We could check $typenow to avoid this, like in my original patch.

#23 @lancewillett
7 years ago

Intentional for pages, but not post types. I'm open to changing it to just "post" post type.

#24 follow-up: @dimadin
7 years ago

For translators comments like in [26153] we're using /* translators: */ block, not context (e.g. http://core.trac.wordpress.org/browser/trunk/src/wp-admin/includes/media.php?rev=25727#L237). In this examples I don't actually see need for any translators comments.

#25 in reply to: ↑ 24 @lancewillett
7 years ago

Replying to dimadin:

For translators comments like in [26153] we're using /* translators: */ block, not context (e.g. http://core.trac.wordpress.org/browser/trunk/src/wp-admin/includes/media.php?rev=25727#L237). In this examples I don't actually see need for any translators comments.

Hmm, good point on not really needed here.

#26 follow-up: @lancewillett
7 years ago

In 26190:

Twenty Fourteen: remove unneeded translator context from theme Help tab text, props domain. See #25837.

#27 follow-up: @lancewillett
7 years ago

Still pending for this to be complete (see notes above):

  1. Welcome Screen additions
  2. Filtering stylesheet "description" field in themes.php -- maybe via a filter
  3. Limit Help tab to only "post" post type edit screen

#28 @dd32
7 years ago

[26153] <a href="%2$s">Appearance > Customize</a>

That middle > will need to be changed or encoded since it's a reserved character in HTML.

#29 @lancewillett
7 years ago

In 26211:

Twenty Fourteen: use HTML entity for arrow in Help text string, props dd32. See #25837.

#30 in reply to: ↑ 26 @lancewillett
7 years ago

Replying to lancewillett:

In 26190:

Twenty Fourteen: remove unneeded translator context from theme Help tab text, props domain. See #25837.

Sorry, dimadin -- your props got missed (my fault, typo).

#31 @lancewillett
7 years ago

  • Keywords needs-patch added; 2nd-opinion ui-feedback has-patch removed

For welcome screen, here's some sample code in case it's a starting point: https://gist.github.com/lancewillett/7491863

#32 in reply to: ↑ 27 @lancewillett
7 years ago

Replying to lancewillett:

Still pending for this to be complete (see notes above):

  1. Filtering stylesheet "description" field in themes.php -- maybe via a filter

Chatted with Matías and Nacin in IRC (see log), it's a no-go since there are no filters on purpose for exposing the stylesheet data.

#33 @lancewillett
7 years ago

Another idea is to add an activation message. After the theme is activated, show a short note on how the theme works and point to a longer explanation / tutorial to get it set up with Featured Content.

@siobhan
7 years ago

Updating theme description

#34 @siobhan
7 years ago

  • Cc siobhan added

@siobhan
7 years ago

Updates customizer text

#35 @lancewillett
7 years ago

In 26360:

Twenty Fourteen: update theme description to be less instructional and more promotional. Pushing the how-to to the Codex and other documentation. Props siobhan, see #25837.

#36 @lancewillett
7 years ago

In 26361:

Twenty Fourteen: update Customizer inline help text. Props siobhan, see #25837.

@siobhan
7 years ago

Updates help text

#37 @chipbennett
7 years ago

  • Keywords has-patch added; needs-patch removed

#38 follow-up: @lancewillett
7 years ago

  • Keywords needs-patch added; has-patch removed

Still needs patches. :)

  1. Limit Help tab to only "post" post type edit screen
  2. Welcome Screen additions.

#39 in reply to: ↑ 38 @chipbennett
7 years ago

Replying to lancewillett:

Still needs patches. :)

  1. Limit Help tab to only "post" post type edit screen
  2. Welcome Screen additions.

That first one should be a pretty easy fix; I'll take a look tomorrow.

#40 follow-up: @Hanni
7 years ago

Looks like the help text for Twenty Fourteen on the Themes page is in <li> tags, which aren't quite styled in same way as other help text wrapped in p tags (the li text i s larger).

#41 in reply to: ↑ 40 @SergeyBiryukov
7 years ago

Replying to Hanni:

Looks like the help text for Twenty Fourteen on the Themes page is in <li> tags, which aren't quite styled in same way as other help text wrapped in p tags (the li text i s larger).

Related: #26300

#42 @samuelsidler
7 years ago

  • Priority changed from normal to high

@obenland
7 years ago

Limits Help tab to only "post" post type edit screen

#43 @lancewillett
7 years ago

In 26555:

Twenty Fourteen: limit Help tab text to only "post" post type edit screen. Props obenland, see #25837.

#44 @lancewillett
7 years ago

  • Keywords needs-patch removed
  • Resolution set to fixed
  • Status changed from new to closed

Going to forgo the Welcome Screen changes; we can look again at that in a future release.

#45 @lancewillett
7 years ago

In 26556:

Twenty Fourteen: update comment blocks to match inline docs standards. Props DrewAPicture, see #25837.

Last edited 7 years ago by DrewAPicture (previous) (diff)

#46 @lancewillett
7 years ago

Thanks to @siobhan we now have a Codex page for explaining how Twenty Fourteen works: http://codex.wordpress.org/Twenty_Fourteen

Rather than littering lots of text in the theme comments or contextual help, we can put all the longer explanations there and point to it.

#47 @lancewillett
7 years ago

In 26630:

Twenty Fourteen: add link to Codex documentation in Help text, and minor cleanup based on siobhan feedback. See #25837.

Note: See TracTickets for help on using tickets.