WordPress.org

Make WordPress Core

Opened 3 years ago

Closed 3 years ago

#17357 closed defect (bug) (fixed)

Theme Options lacking specific contextual help/link in Admin bar

Reported by: dougwrites Owned by: sbressler
Milestone: 3.2 Priority: normal
Severity: minor Version: 3.2
Component: Administration Keywords: has-patch ux-feedback
Focuses: Cc:

Description

This is for when a theme calls a separate Theme Options screen. They should have a contextual help tab with content more specific than just "Documentation, Support Forums." Duster and Twenty Eleven have exposed this hole but I think it applies to all themes that call such a custom Options page. (I believe an individual theme could create an Options-specific tab to override the generic two links, but a specific default would be a better solution).

Also, as per Ticket #17263 for custom header and background, shouldn't Admin Bar> Appearance >Theme Options be added in the dropdown for consistency?

Attachments (3)

17357.diff (4.5 KB) - added by sbressler 3 years ago.
Patch for help documentation for theme pages
17357.2.diff (2.8 KB) - added by sbressler 3 years ago.
Patch with help documentation for Twenty Eleven theme only
17357.3.diff (3.3 KB) - added by sbressler 3 years ago.
Updated diff with Jane's text

Download all attachments as: .zip

Change History (21)

comment:1 dougwrites3 years ago

Sample content for such a help tab (although this time I can't find where in the wp-admin to put this):

The Theme Options screen, if enabled by your installed theme, allows some options to change color and layout. Remember to click Save to activate any changes.

If you want to make advanced color/layout changes in a theme, you can edit the CSS (cascading style sheets) http://codex.wordpress.org/CSS and http://codex.wordpress.org/Know_Your_Sources#CSS in the Appearance >(Theme) Editor screen. You should also consider using a child theme http://codex.wordpress.org/Child_Themes for such modifications to protect the original parent theme for both reversions and updates.

Documentation on Theme Options Screen http://codex.wordpress.org/Appearance_Theme_Options_Screen

Support Forums
http://wordpress.org/support/

comment:2 dougwrites3 years ago

I meant which php (or css?) file in the wp-admin file directory where this could be inserted...

comment:3 nacin3 years ago

  • Milestone changed from Awaiting Review to 3.2

We can add help text to the screen.

comment:4 nacin3 years ago

If you want to provide text that is specific to Twenty Eleven's Theme Options page, I can provide a patch.

comment:5 dougwrites3 years ago

@nacin: Just for Twenty Eleven:

This Theme Options screen, as enabled here by your theme Twenty Eleven, allows some options to change color and layout.

You can toggle between Light or Dark background in Color Scheme, with contrasting letters. Colors could be further changed or examined in the CSS files via Appearance > Editor. The color for links can be changed via #hexadecimal value or a color wheel pop up activated by the color patch or Select a Color button.

Layout offers three options. All have a main column for content; a widget area can be put on the right side, on the left side, or be absent altogether.

Remember to click Save to activate any changes.

Documentation on Theme Options Screen http://codex.wordpress.org/Appearance_Theme_Options_Screen

Documentation on Using CSS http://codex.wordpress.org/Know_Your_Sources#CSS

Support Forums http://wordpress.org/support/

comment:6 dougwrites3 years ago

Better second paragraph:

You can toggle between Light or Dark text areas for your site in Color Scheme, with contrasting letters. Colors could be further changed or examined in the CSS files via Appearance > Editor. The color for links can be changed via #hexadecimal value or a color wheel pop up via clicking on the color patch or Select a Color button.

sbressler3 years ago

Patch for help documentation for theme pages

comment:7 sbressler3 years ago

  • Cc sbressler@… added
  • Keywords has-patch dev-feedback added
  • Owner set to sbressler
  • Status changed from new to accepted

Added a patch for this issue. It includes default documentation for all theme pages as well as some more specific documentation for Twenty Eleven. I tried to clean up the text provided by Doug a bit, but it still needs some more work, particularly the second paragraph. Should be a good start, though.

comment:8 nacin3 years ago

Can't see us wanting to go with default documentation, but thanks for coding it up. The twentyeleven diff looks good.

I have the lowercase "sidebar" in my sandbox, too. :-)

sbressler3 years ago

Patch with help documentation for Twenty Eleven theme only

comment:9 sbressler3 years ago

Attached a patch without the default documentation

comment:10 dougwrites3 years ago

The Theme Options screen is not appearing in my network testing site (subdirectories). Is this intentional?

comment:11 follow-up: dougwrites3 years ago

Reworked tab content, building upon sbressler's improvements:

This Theme Options screen, as enabled by your theme, Twenty Eleven, allows you to change some settings regarding the theme's color and layout.

You can toggle between Light or Dark text areas for your site in Color Scheme, with contrasting letters. Colors could be further changed or examined in the theme's CSS via Appearance > Editor. You can change the color for links via the #hexadecimal value or a color wheel (click on the color patch or "Select a Color" button).

There are three options for the theme's layout, moving around the sidebar for widgets:

Main content on left, sidebar on right

Main content on right, sidebar on left

Main content spans the entire site's width, no sidebar

Remember to click "Save Changes" to save any changes you have made to the theme's options.

comment:12 in reply to: ↑ 11 sbressler3 years ago

Replying to dougwrites:

Reworked tab content, building upon sbressler's improvements:

[snip]

Hmm, the only changes I notice are to the end of paragraph 2, which I think still needs major work (hopefully by Jane?), and to paragraph 3, the change to which I personally don't think enhances the wording.

comment:13 dougwrites3 years ago

@sbressler: Regarding paragraph 3, I think referring to the (site) header could be extraneous and confusing when there are also admin headers and, in Twenty Eleven, footer widget areas which every layout also contains in the same position. "Sidebar" could need the passing reference that it is what is moved and it contains widgets, but we could just end at "theme's layout."

I did not intend "reworking" to imply "extensive." Just meant minor, ongoing tinkering.

comment:14 jane3 years ago

Revised text per request!

............................

Some themes provide customization options that are grouped together on a Theme Options screen. If you change themes, options may change or disappear as they are theme-specific. Your current theme, Twenty Eleven, provides the following Theme Options:

  • Color Scheme. You can choose a "Light" (light background with dark text) or "Dark" (a dark backgrounh with light text) color palette for your site.
  • Link Color. You can choose the color used for text links on your site. You can enter the HTML color or hex code, or you can choose visually by clicking the "Select a Color" button to pick from a color wheel.
  • Layout. You can choose if you want your site's default layout to have a sidebar on the left, the right, or not at all.

Remember to click "Save Changes" to save any changes you have made to the theme options.

............................

Note: if someone wanted to change the options label te Default Layout instead of layout that would be cool. Since layout can be changed per page with template selection, etc.

comment:15 dougwrites3 years ago

s/backgrounh/background

sbressler3 years ago

Updated diff with Jane's text

comment:16 sbressler3 years ago

  • Keywords ux-feedback added; dev-feedback removed

Updated with Jane's text. I tweaked in a few places, but only minorly: made bullet point headings bold and changing ordering of the wording of the first bullet point.

One thing I couldn't decide on: "not at all" or "none at all". "not at all" sounds a bit strange, but maybe it's just me:

"You can choose if you want your site's default layout to have a sidebar on the left, the right, or not at all."

I also changed "Layout" to "Default Layout" as suggested.

comment:17 dougwrites3 years ago

Style thing: do we want the quote marks on Light, Dark, Select a Color, Save Changes, or just capitalize the first letter of each word?

comment:18 ryan3 years ago

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

In [18101]:

Contextual help for twentyeleven's theme options screen. Props sbressler, dougwrites, jane. fixes #17357

Note: See TracTickets for help on using tickets.