WDNS - Readme Parser

Read and formats text files (readme.txt)

Description

Reads a file into an array using the specified path or url. The file should correspond to the WordPress readme.txt specification.

Features

  • Reads a file into an array using the specified path.
  • Outputs metadata in a table.
  • HTML / CSS tabs for individual sections.
  • Basic text formatting according to the Mark Down Syntax.
  • Strict or open mode (strict mode must be the name of the readme.txt file).
  • Lightweight and fast rendering

Languages

Meta tags and their order

  • Plugin Name
  • Author URI
  • Plugin URI
  • Contributors
  • Donate link
  • Tags
  • Version
  • Stable tag
  • Requires PHP
  • Tested up to
  • Requires at least
  • WC requires at least
  • WC tested up to
  • License
  • License URI

Installation

  • Unzip and upload contents to your plugins directory (usually wp-content/plugins/).
  • Activate plugin
  • Visit Settings page under Settings -> WP Updates Monitor in your WordPress Administration Area
  • Configure plugin settings
  • Wait for email notifications of updates

Changelog

1.0.2 (2023-12-20) Keep Alive Release

  • Tweaked - Tested with WP 6.4

1.0.1 (2023-09-xx)

  • Fixed - readme.txt Header Fields corrected

1.0.0 (2023-06-12)

  • Version - Bump version to 1.0.0
  • Fixed - Some PHP 8.2 issues fixed

0.1.0 (2023-04-14)

  • Tweaked - Output escaping
  • Tweaked - Metadata table extended and systematic sorting (not the WP way)
  • Tweaked - Check if allow_url_fopen is set in php.ini otherwise try to use local filesystem path
  • Added - Language files (.po, .mo)
  • Fixed - Removed the "type="text/javascript" tag

0.0.2 (2020-12-06)

  • Added - Support for ordered lists
  • Added - Responsive design/layout
  • Added - Plugin update functionality
  • Fixed - Escaping content to avoid javascript errors

0.0.1 (2020-11-20)

  • Initial Alpha Release (for testing only)

Open issues

  • Screenshots not supportet yet
  • No format option for inline code blocks
  • Clean up and optimize PHP code

Shortcode

Usage the shortcode to render the readme.txt file:



[wdns-reaser strict="0" path="path-or-url-to-file/readme.txt"][/wdns-reaser]
Plugin Name:WDNS - Readme Parser
Author URI:https://wdns.at
Plugin URI:https://devops.wdns.at/wdns-readme-parser/
Contributors:The WDNS.at Team by (A.Kra.)
Donate link:https://devops.wdns.at/donate
Tags: Parser, readme.txt, WP PlugIn
Version: 1.0.2
Stable tag: 1.0.0
Requires PHP: 7.0
Tested up to: 6.4
Requires at least:5.1
License: GPLv3 or later
License URI:https://www.gnu.org/licenses/gpl-3.0.html

File has been read by: HTTP(s) Request
Page rendered by WDNS Readme Parser in 0.00033 seconds.

The WDNS DEVOPS portal is currently under developement!

The UX, the content and further information will be available in the coming weeks.