前言介紹
- 這款 WordPress 外掛「Readme Generator」是 2011-06-14 上架。
- 目前有 10 個安裝啟用數。
- 上一次更新是 2013-09-12，距離現在已有 4253 天。超過一年沒更新，安裝要確認版本是否可用。以及後續維護問題！
- 外掛最低要求 WordPress 3.1 以上版本才可以安裝。
- 尚未有人給過這款外掛評分。
- 還沒有人在論壇上發問，可能目前使用數不多，還沒有什麼大問題。
外掛協作開發者
外掛標籤
內容簡介
此外掛可讓插件作者在其網站上的一個或一組頁面或文章中編寫插件說明文件，然後點擊按鈕即可自動生成相關的有效 readme.txt 文件。功能包括：簡單的 HTML 到 Markdown 轉換、幫助 widget、全局選項、插入模板、基本 i18n 驗證和 .pot 文件生成、單頁面或子頁面的處理。最新版本為 1.0.2，新增了支援生成上下文幫助數據文件、修復了一些錯誤。未來計劃改進的功能包括：從「視覺化」的 Post/Page 編輯獲取內容，以及在顯示郵件時添加彈出 widget 以顯示標題詳細信息和鏈接。此外掛還提供多個選項，可以在單個帖子/頁面上輸入 Plugin 名稱、Contributors、Donate Link、Tags、 Required Version、Tested Version、Stable Version、Readme Location、Ignore Sections、 Heading Type、Sub-Heading Type、Plugin Category 和 Parent Page 等插件特定的選項，也可以在全局選項中設置默認值並配置插件的行為。
原文外掛簡介
This plugin enables plugin authors to write their plugin readme content inside a page (or set of pages) or post on their site and then at the click of a button generate the associated valid readme.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
Sets the name of the Plugin for which the readme.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
The plugin subdirectory where the ‘readme.txt’ should be written, usually set to the plugin directory. This is relative to the WordPress plugin directory ‘wp-content/plugins’.
Ignore Sections
If there are any sections or sub-sections that are in the post that should not be present in the readme.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
The name of the file that the Readme Generator will create, by default this is ‘readme.txt’, if you want to keep your existing readme.txt set this to something else.
Parse Sub-Pages
If this option is selected then it will also append any pages that are children of the current page to the readme.txt file.
Generate POT
The plugin can generate a .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
The name of the .pot file that the Readme Generator will create, by default this is ‘i18n/%SLUG%.pot’. The location is relative to the directory of the ‘readme.txt’, and the phrase %SLUG% will be replaced with the Plugin Name (e.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. If you want to help to translate the plugin to your language, please have a look at the i18n/readme-gen.pot file which contains all definitions and may be used to create a language specific .po file. If you do create a translation please contact me and I will add it to the plugin ready for the next update.
各版本下載點
- 方法一：點下方版本號的連結下載 ZIP 檔案後，登入網站後台左側選單「外掛」的「安裝外掛」，然後選擇上方的「上傳外掛」，把下載回去的 ZIP 外掛打包檔案上傳上去安裝與啟用。
- 方法二：透過「安裝外掛」的畫面右方搜尋功能，搜尋外掛名稱「Readme Generator」來進行安裝。
（建議使用方法二，確保安裝的版本符合當前運作的 WordPress 環境。
延伸相關外掛（你可能也想知道）
暫無相關外掛推薦。