WordPress.org

Make WordPress Core

Opened 3 years ago

Last modified 3 months ago

#36971 reopened enhancement

Show readme.txt from Themes

Reported by: zodiac1978 Owned by:
Milestone: Awaiting Review Priority: normal
Severity: normal Version:
Component: Themes Keywords:
Focuses: ui Cc:

Description

The readme.txt should be used to document any dependencies of a theme. But if we install the theme from inside WordPress there is no way to see the readme.txt for an unexperienced user.

For example the Sela theme needs Jetpack to show Testimonials.
See readme.txt: https://themes.svn.wordpress.org/sela/1.0.9/readme.txt

But the theme page is not mentioning that (https://wordpress.org/themes/sela/) and there is no direct link or presentation of the readme.txt with this essential information on the theme page or inside WordPress.

I suggest showing the readme.txt somewhere or use a system like https://github.com/TGMPA/TGM-Plugin-Activation to give this information to the user.

Change History (16)

#1 @jcastaneda
3 years ago

There is one that was opened three years ago: #22810

And one for meta as well:
https://meta.trac.wordpress.org/ticket/45

Last edited 8 months ago by SergeyBiryukov (previous) (diff)

#2 @ocean90
3 years ago

  • Milestone Awaiting Review deleted
  • Resolution set to maybelater
  • Status changed from new to closed
  • Version trunk deleted

For changelogs see #22810 and #meta45, for displaying the data see #25707 and #meta215.

Going to close this as maybelater since a readme.txt is currently not a requirement and it doesn't seem like there is a standard yet. This should be discussed with the theme review team first.

#3 follow-up: @zodiac1978
3 years ago

I suggest re-opening, because #meta215 is for the Theme directory and #meta45 is for changelogs. What is about showing readme.txt in WordPress core (/wp-admin/themes.php)?

#4 @zodiac1978
3 years ago

  • Resolution maybelater deleted
  • Status changed from closed to reopened

#5 in reply to: ↑ 3 ; follow-up: @ocean90
3 years ago

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

Replying to zodiac1978:

I suggest re-opening, because #meta215 is for the Theme directory and #meta45 is for changelogs. What is about showing readme.txt in WordPress core (/wp-admin/themes.php)?

Changelogs are probably part of the readme.txt. But still, my main reason was:

… a readme.txt is currently not a requirement and it doesn't seem like there is a standard yet. This should be discussed with the theme review team first.

We can't display something that doesn't exist and/or has a proper specification.

#6 in reply to: ↑ 5 @zodiac1978
3 years ago

Replying to ocean90:

We can't display something that doesn't exist and/or has a proper specification.

Couldn't we check if a readme.txt exists and if it does, show it completely in a (disabled/non-editable) textarea?

#7 @zodiac1978
2 years ago

If you don't want to wait for a solution on wp.org, there is a plugin for showing at least the changelogs:
https://wordpress.org/plugins/wp-theme-changelogs/

Last edited 2 years ago by zodiac1978 (previous) (diff)

#8 follow-up: @zodiac1978
16 months ago

Themes are recommended to include a readme.txt file, using plugin directory’s readme.txt markdown format. This recommendation will soon become required.

https://developer.wordpress.org/themes/release/writing-documentation/

Maybe this ticket could be revisited if a readme.txt is required.

I'm still convinced that we are violating the attribution requirement if we hide those attributions in a readme.txt which is not shown to any backend user.

Declare licenses of any resources included such as fonts or images.

This requirement from the theme team is typically handled through a readme.txt.

This ticket was mentioned in Slack in #meta by sergey. View the logs.


8 months ago

This ticket was mentioned in Slack in #themereview by joyously. View the logs.


8 months ago

This ticket was mentioned in Slack in #themereview by joyously. View the logs.


8 months ago

This ticket was mentioned in Slack in #design by boemedia. View the logs.


8 months ago

This ticket was mentioned in Slack in #design by karmatosed. View the logs.


7 months ago

This ticket was mentioned in Slack in #core by joyously. View the logs.


6 months ago

#15 in reply to: ↑ 8 @joyously
6 months ago

  • Resolution maybelater deleted
  • Status changed from closed to reopened

Replying to zodiac1978:

Maybe this ticket could be revisited if a readme.txt is required.

The readme.txt file is required as of Oct 25, 2018.

https://make.wordpress.org/themes/handbook/review/required/#readme-txt-file

#16 @SergeyBiryukov
3 months ago

  • Milestone set to Awaiting Review
Note: See TracTickets for help on using tickets.