WordPress.org

Making WordPress.org

Opened 4 years ago

Closed 4 years ago

Last modified 4 years ago

#1493 closed enhancement (maybelater)

README Table of Contents

Reported by: dan.rossiter Owned by:
Milestone: Priority: high
Component: Plugin Directory Keywords:
Cc:

Description

As WordPress plugins grow in complexity, the need for more sophisticated documentation also increases. A TOC tag, implemented on a per-page basis, would allow for this more sophisticated documentation.

The proposed syntax would be either <!-- TOC --> or {{TOC}}. Ideally, the tag would take attribute(s) allowing the user to specify how many levels of headers to be included, though this would not be entirely necessary.

Change History (3)

#2 @Otto42
4 years ago

  • Resolution set to wontfix
  • Status changed from new to closed

The current implementation of the readme.txt files does not support readme files much larger than about 10k to begin with, and even that causes major problems since the content of the readme.txt is sent as part of the API response.

Therefore, I would recommend NOT using the readme.txt for extensive documentation to begin with. Large changelogs should be moved out into separate files. FAQ sections should be limited to question for users *prior* to them installing your plugin.

Documentation on using the plugin should be contained within the plugin itself, possibly using the Help tabs built into WordPress or some other kind of explanatory screens in the admin. The readme.txt is not really the end-all be all of documentation.

As such, wontfix for now. Even in the future, when the readme.txt size limitation is removed, it will still be sent along in the API response, and so an arbitrary size limitation will likely be implemented. Probably about 8k or less.

#3 @dd32
4 years ago

  • Resolution changed from wontfix to maybelater
Note: See TracTickets for help on using tickets.