Feature Request: Readme.txt generated tabs on theme pages

[iandstewart]

Like plugins it'd be really cool to have readme.txt-generated tabs on theme pages. Maybe taking over from style.css descriptions? As themes get more complicated this can really help users better understand how to use them and find support. Even for uncomplicated themes it can still be useful. Like, say, if the theme uses post formats, it's a great place to describe them.

I think I've seen this mentioned somewhere before but I couldn't find a ticket.

[nacin]

One possible blocker: We don't actually have a formal, accepted theme readme.txt standard.

[chipbennett]

Perhaps start from ​the Plugin readme standard, and then work from there?

This is a much-needed feature, that would be really useful.

[cais]

Replying to nacin:

One possible blocker: We don't actually have a formal, accepted theme readme.txt standard.

Replying to chipbennett:

Perhaps start from ​the Plugin readme standard, and then work from there?

This is a much-needed feature, that would be really useful.

As suggested by Chip here, we (WPTRT) have been suggesting to follow the WordPress Plugin readme.txt format for quite some time now. No reason not to start there would be my opinion as well.

I actually use the Plugin ​Readme Validator to view my themes' readme.txt files all the time just to see how they would be parsed with a similar system.

[emiluzelac]

Extremely useful and very much needed :)

[DannyCooper]

+1 - The biggest concern to authors right now is that they can't display their themes in the best light due to restrictive screenshot and preview guidelines. Multiple screenshots like the plugin directory has would solve this.

What's the best way to move this ticket forward? The plugin directory already has a working (superior) solution.

[Air.]

I don't know if the number of replies matter, but this was very strange for me that something(readme.txt) working so well for plugins is not done for themes, while they, in theory, have same possibilities as plugins.

That is also one of many reasons why releasing plugins and themes on wordpress.org are SOO different experiences(with a big advantage for plugins).

+1 for readme.txt support!

[SergeyBiryukov]

Related: #45, #969, #1358, #3718; ​#WP22810, ​#WP36971.

[dingo_d]

Since we already have the requirement for themes to implement valid readme like the plugins do (​https://make.wordpress.org/themes/handbook/review/required/#readme-txt-file), there is no reason this shouldn't be implemented.

We discussed this on the WCEU and would like to move forward to unifying themes and plugin start page, give themes more versatility etc.

I'm not sure what is needed for this to happen, the thing that was needed from the TRT side is done (readme.txt required).
So if you can make some guide what needs to happen, some points where we can help that would be great :)

[dingo_d]

In order to use readme we need to be able to parse the readme data and store it in the theme meta data

1. Parse readme data on theme being set live (approved)
2. Store parsed data to theme meta data
3. Use that to display the data
4. Style it as plugins
5. Celebrate

@williampatton mentioned that he'd look into parsing the data and we can work off of that.

[dd32]

This ticket is really pending design for WordPress.org and Core - Parsing the readme's is pointless if there's nowhere reasonable or a decent way to display it.

If the intention is to redesign the entire page, to be similar to plugins rather than what it currently is, lets get some focused work on that first.

[joyously]

Replying to dd32:

This ticket is really pending design for WordPress.org and Core - Parsing the readme's is pointless if there's nowhere reasonable or a decent way to display it.

If the intention is to redesign the entire page, to be similar to plugins rather than what it currently is, lets get some focused work on that first.

Today I was advised to write a new ticket just for the parsing of the readme, so that we could have an actionable ticket and make some progress. But with this comment, you contradict that.
I think that we need the parsing of the data first, and then we can work on getting the data shown in the admin and in the Theme directory. We can't work on those until there is data to work with.
The readme has been required since Oct 2018, so it's past time to start using it.
Themes really need a way to convey information to users, especially for something like Full Site Editing that is coming soon. We need to get this in place before that happens.
Start with gathering the data, and iterate.