WordPress plugin intelligence profile

Readme Generator

A simple plugin to convert a HTML post or page content into a plugin readme.txt file.

WP PlugIndex snapshot

Current directory snapshot

Tested up to WordPress 3.6
Current version1.0.2
WordPress coverageTested up to WordPress 3.6
Minimum stackWP 3.1 · PHP —
Directory statusactive
Last directory update12 Sept 201313y ago
Active installations10Adoption metric — not a quality score
WordPress.org ratingNo WordPress.org ratings yet
Official packageDirect from WordPress.org

Repository metrics are context, not quality scores. Active installations measure adoption and can strongly reflect a plugin’s age and historical popularity. Ratings, recent updates and “Tested up to” metadata also do not guarantee modern code, error-free operation, security, feature completeness or suitability for a particular site. Why active installs don’t tell the whole story →

WP PlugIndex currently records Readme Generator version 1.0.2 as active, updated 13y ago and tested up to WordPress 3.6.

Overview

About this plugin

txt file automatically.

Features

  • Simple HTML to Markdown conversion
  • Helper widget on Post/Page edit screen to set plugin specific options and Generate the readme
  • Global options to set the default values and configure the plugin’s behaviour
  • Facility to insert a ‘starter’ template into the current post
  • Basic i18n verification and.pot file generation
  • Handles single page based readme or page with children

Latest Version – 1.0.2

  • Add support for Generation of contextual Help Data Files
  • Minor Bug Fixes

Future Updates

Some improvements that I hope to make to the plugin:

  • Take content from ‘Visual’ Post/Page edit
  • Add popup widget when post displayed showing Header details, and links

Options

The plugin has a number of options some are saved locally with individual posts/pages and some are global and are used to modify the behaviour of the plugin.

Plugin Name

txt file is to be generated. This options is saved for each plugin page/post.

Contributors

This sets the list of contributors for the plugin. This option is saved for each plugin page/post, and the default for this value can be set in the global options.

Donate Link

This sets the donate link for the plugin. This option is saved for each plugin page/post, and the default for this value can be set in the global options.

Tags

This sets the list of tags for the plugin. This option is saved for each plugin page/post, and the default for this value can be set in the global options.

Required Version

This sets the minimum required version of WordPress that the plugin will work with. This option is saved for each plugin page/post, and the default for this value can be set in the global options.

Tested Version

This sets the highest version of WordPress that the plugin has been tested against. This option is saved for each plugin page/post, and the default for this value can be set in the global options.

Stable Version

This sets the stable version of the plugin that should be downloaded by users. This option is saved for each plugin page/post.

Readme Location

txt’ should be written, usually set to the plugin directory. This is relative to the WordPress plugin directory ‘wp-content/plugins’.

Ignore Sections

txt, then enter their names here as a comma separated list.

Heading Type

This global setting, defines what html element the plugin will use to define the plugin top level headings & sections.

Sub-Heading Type

This global setting, defines what html element the plugin will use to define the plugin sub-headings & sections.

Plugin Category

If all your plugin posts are of a specific category, then put the category’s slug or ID’s in this setting so that the Readme Generator is enabled by default for these posts.

Parent Page

If all your plugin posts are children of a specific post/page, then put the post’s slug or ID’s in this setting so that the Readme Generator is enabled by default for these posts.

Readme Filename

txt set this to something else.

Parse Sub-Pages

txt file.

Generate POT

pot file, however this is quiet primitive, enable this option to generate the POT file. This option is saved for each plugin page/post, and the default for this value can be set in the global options.

POT Filename

pot’. g. plugin-name).

Translations

The plugin comes with translation support but as yet no translations are included. Please refer to the WordPress Codex for more information about activating the translation. po file.

If you do create a translation please contact me and I will add it to the plugin ready for the next update.

WordPress.org metadata

Plugin tags

Topics listed for this plugin in the WordPress.org directory.

  • readme txt plugin markdown
  • readme.txt
Compatibility & maintenance

Compatibility & maintenance

Tested up to WordPress 3.6

Not yet marked as tested with WordPress 7.1. WordPress.org currently lists Tested up to 3.6.

Current WordPress releaseWordPress 7.1
WordPress.org Tested up to3.6
Minimum requirementsWordPress 3.1 · PHP not listed
Update activity12 Sept 201313y ago

“Tested up to” is directory metadata supplied by the plugin author. WP PlugIndex does not turn an older declaration into a claim that the plugin is incompatible.

Changes recorded by WP PlugIndex

Recent tracked changes

No tracked version or compatibility changes have been recorded by WP PlugIndex yet.

Tracking & source

WP PlugIndex tracks public WordPress.org directory metadata and records selected version, compatibility and availability changes as they are detected.

Plugin watchlist

Watch this plugin

Sign in to your WP PlugIndex account or create a free account. Free accounts can watch up to 5 plugins and see what changed.

Watch limit

Watchlist limit reached

You have reached your current active watch limit.