Opened 14 months ago
Last modified 14 months ago
#20318 new enhancement
Introduce a Usage section to the Plugins API
| Reported by: |
|
Owned by: | |
|---|---|---|---|
| Priority: | normal | Milestone: | WordPress.org |
| Component: | WordPress.org site | Version: | |
| Severity: | normal | Keywords: | |
| Cc: |
Description
I quite often find a need for a 'Usage' section in my plugin's readme file. I usually place this within the 'Installation' section (example), but I've seen other plugins that include full usage instructions in the main description, in the FAQs, or in the 'Other Notes' section.
It would be nice if there was a top level readme section for Usage which showed up as a tab on the WordPress.org Plugin Directory.
Change History (5)
I think renaming "Installation" to "Usage" would be enough
I like that, considering that most Plugins should not have any "installation" steps anymore, the ones that do (caching plugins for example) would still be able to list any custom installation procedures required in a Usage tab.
- Type changed from feature request to enhancement
I think Instructions or Directions would be a better label. When I first saw this ticket I thought Usage referred to how/how many people were using the plugin.
"Instructions" sounds fine to me.
It would take it's content from either the == Instructions == section in readme.txt or from == Installation == to preserve back-compat for all the existing plugins.
comment:5
in reply to:
↑ 4
johnbillion — 14 months ago
Replying to scribu:
"Instructions" sounds fine to me.
It would take it's content from either the == Instructions == section in readme.txt or from == Installation == to preserve back-compat for all the existing plugins.
That all sounds good. +1 from me.
I think renaming "Installation" to "Usage" would be enough, since most of the times you can skip the installation steps altogether.