Make WordPress Core

Opened 22 months ago

Closed 21 months ago

Last modified 20 months ago

#56405 closed enhancement (fixed)

Add a help tab in Theme Install screen for the new "Block Themes" search filter.

Reported by: audrasjb's profile audrasjb Owned by: poena's profile poena
Milestone: 6.1 Priority: normal
Severity: normal Version: 6.1
Component: Help/About Keywords: has-patch has-copy-review needs-user-docs
Focuses: ui-copy Cc:

Description

Follow-up to #56283 / [53906] / #meta6330.

Now that #56283 is committed, we may consider adding a new help tab to explain what Block Themes are.

We can probably reuse the Block Theme definition available in the Block Editor Handbook:

A block theme is a WordPress theme with templates entirely composed of blocks so that in addition to the post content of the different post types (pages, posts, …), the block editor can also be used to edit all areas of the site: headers, footers, sidebars, etc.

Attachments (4)

56405.diff (1.5 KB) - added by poena 21 months ago.
56405 Add block theme help tab
Capture d’écran 2022-09-12 à 15.43.47.2.png (998.2 KB) - added by audrasjb 21 months ago.
Block Themes tab in WP 6.1
56405-2.diff (1.3 KB) - added by poena 21 months ago.
Removed reference to how to use the feature filter
Screenshot 2022-09-15 at 9.27.13 PM.png (377.5 KB) - added by robinwpdeveloper 21 months ago.

Download all attachments as: .zip

Change History (21)

#1 @poena
21 months ago

  • Owner set to poena
  • Status changed from new to assigned

@poena
21 months ago

56405 Add block theme help tab

#2 @poena
21 months ago

Testing instructions

Apply the patch.
Log in to your WordPress installation as a user that has access to switching themes.
Go to Appearance, Themes and select the "Add New" button.
In top right corner, select the "Help" button to expand the help panel.
The panel on this screen should have three tabs: "Overview", "Previewing and Installing", and "Block Themes".

In the more information sidebar inside the panel there should be three links, the new link added in the patch goes to the end user support article about block themes.

  • Feedback on the copy is very welcome.

#3 @audrasjb
21 months ago

  • Keywords changes-requested added

Thanks for the patch @poena!

I only have two remarks:

  • I think we shouldn't have any linebreak or starting/trailing spaces in translatable strings
  • I think we should rephrase a bit this sentence: "You can search for block themes using the Feature Filter, by checking the box for the keyword "full site editing". Indeed, [53906] added an easier way to filter block themes: you only have to click on the "Block Themes" tab of the Theme Install screen :)

@audrasjb
21 months ago

Block Themes tab in WP 6.1

@poena
21 months ago

Removed reference to how to use the feature filter

#4 @audrasjb
21 months ago

  • Keywords changes-requested removed

The patch looks good to me, thank you @poena!
Would be nice to get some copy review. Are you interested @marybaum? :D

#5 @robinwpdeveloper
21 months ago

Thanks @poena
Patch looks good to me.

Attached the screenshot.
Tested with:
Browser: Chrome
OS: MacOS
WordPress: Latest trunk version (6.1-alpha-53344-src)

#6 @audrasjb
21 months ago

Thanks @robinwpdeveloper but we already know the patch works fine :) Right now, we need the copy (= texts) to be reviewed before commit.
Pinging also @webcommsat who could help with copy review :)

#7 @webcommsat
21 months ago

Thanks @audrasjb .

1) Proposed text:
'"A block theme is a theme that uses blocks for all parts of a site including navigation menus, header, content, and site footer. These themes are built for the newest features in WordPress that allow you to edit and customize all parts of your site.'
' With a block theme, you can place and edit blocks outside your content by customizing or creating new templates."

Suggestion:
I would suggest incorporating a sentence on what a block is or linking to the definition of a block.
Some ways to do this:

  • link to the definition in the codex glossary, which describes it as: "The abstract term used to describe units of markup that, composed together, form the content or layout of a webpage." However, this is not the easiest of texts for a non developer audience, but at least gives a link to what a block is for anyone new to it.
  • add a description for blocks, eg: "Blocks are a new way of organizing content on a page or post."

2) In terms of "place and edit blocks outside your content", this may be slightly confusing when translating.
Can we say something like "place and edit blocks without affecting your content" or "... separate to your content" assuming this is what is meant in this reference?

3) Reference to 'newest' - unless this copy is marked for a change again in a year or so, will these features still be ones we want to describe in this way?

4) It could be valuable to link to a developer hub page on customizing blocks.

Let me know if there was anything else you wanted a copy review on to get this ticket completed. Thanks

#8 @audrasjb
21 months ago

  • Keywords has-patch changes-requested has-copy-review added; needs-copy-review removed

Thanks for the review @webcommsat!

I agree with some of your changes to the original text, however I don't think it is a good place to explain what is a block, or how to customize them :)

I'll put together a new PR so hopefully we can ship something before beta 1 :)

#10 @audrasjb
21 months ago

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

In 54252:

Help/About: Add a help tab in Theme Install screen for the new "Block Themes" search filter.

Follow-up to [53906].

Props audrasjb, poena, robinwpdeveloper, webcommsat.
Fixes #56405.

#12 @kebbet
21 months ago

  • Resolution fixed deleted
  • Status changed from closed to reopened

Why is there i whitespace at the beginning of the second paragraph? It should be removed in my opinon, as it confuses the work for translators.

__( ' With a block theme, you can place and edit blocks without affecting your content by customizing or creating new templates.' )

#14 @audrasjb
21 months ago

  • Keywords changes-requested removed

Thanks for spotting this @kebbet :)

#15 @audrasjb
21 months ago

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

In 54268:

Help/About: Remove an unwanted whitespace in a Theme Install screen help tab string.

Follow-up to [54252].

Props kebbet.
Fixes #56405.

#17 @milana_cap
20 months ago

  • Keywords needs-user-docs added
Note: See TracTickets for help on using tickets.