[WordPress] 外掛分享： {eac}Doojigger Readme Extension for WordPress

前言介紹

• 這款 WordPress 外掛「{eac}Doojigger Readme Extension for WordPress」是 2022-07-25 上架。
• 目前尚無安裝啟用數，是個很新的外掛。如有要安裝使用，建議多測試確保功能沒問題！
• 上一次更新是 2025-04-29，距離現在已有 3 天。
• 外掛最低要求 WordPress 5.8 以上版本才可以安裝。
• 外掛要求網站主機運作至少需要 PHP 版本 7.4 以上。
• 尚未有人給過這款外掛評分。
• 還沒有人在論壇上發問，可能目前使用數不多，還沒有什麼大問題。

外掛協作開發者

kevinburkholder |

外掛標籤

readme | markdown | parsedown | eacDoojigger | code highlighting |

內容簡介

ault translation table

# Default translation table
authentication_required=Authentication Required
changelog=Changelog
configuration=Configuration
contributing=Contributing
contributors=Contributors
credits=Credits
custom_fields=Custom Fields
customization=Customization
description=Description
development=Development
detailed_description=Detailed Description
donate_link=Donate Link
email=email
faq=FAQ
features=Features
homepage=Homepage
installation=Installation
installation_instructions=Installation Instructions
is_multisite=Is Multi-site?
last_updated=Last Updated
license=License
limitations=Limitations
minimum_requirements=Minimum Requirements
name=Name
plugin_information=Plugin Information
faq_question=Question
readme=Readme
readme_or_changelog=Readme or Changelog
requires=Requires
requires_at_least=Requires at Least
screenshots=Screenshots
short_description=Short Description
similar_plugins=Similar Plugins
stable_tag=Stable Tag
support=Support
tested_up_to=Tested Up to WordPress
translation_credits=Translation Credits
upgrade_notice=Upgrade Notice
usage=Usage
user_guide=User Guide
*/

# Usage: [eacReadme translate='name=newname,...']
langtrans_name=Chinese Name
langtrans_description=Chinese Description
langtrans_author=中文作者

原文外掛簡介

{eac}Readme is an {eac}Doojigger extension which loads and translates a WordPress markdown ‘readme.txt’ file providing shortcodes to access header lines and section blocks.
Shortcode Usage
The first used shortcode must indicate the file to load…
[eacReadme file='/docfolder/readme.txt'] # file is relative to the WordPress document root folder
[eacReadme content='/contentfolder/readme.txt'] # content file is relative to the WordPress content folder (wp-content/)
[eacReadme plugin='/pluginfolder/readme.txt'] # plugin file is relative to the WordPress plugins folder (wp-content/plugins/)
[eacReadme theme='/themefolder/readme.txt'] # theme file is relative to the WordPress themes folder (wp-content/themes/)
[eacReadme wpsvn='/slugname/trunk/readme.txt'] # load file from WordPress SVN repository
[eacReadme github='/owner/repository/main/readme.txt'] # load file from github repository

After which, headers and sections may be pulled from that file…
[eacReadme]All Headers[/eacReadme] # parses all header lines
[eacReadme]headerName[/eacReadme] # gets the value of the named header line

[eacReadme]All Sections[/eacReadme] # parses all section blocks
[eacReadme]sectionName[/eacReadme] # parses the content of the named section block
[eacReadme]sectionName/sub-section[/eacReadme] # parses the content of the named sub-section within section block

One shortcode can do it all…
[eacReadme plugin='/pluginfolder/readme.txt']Document[/eacReadme] # loads the file and parses the entire document

Or load the entire file as a single code block…
[eacReadme theme='/themefolder/functions.php']Code File[/eacReadme]

Shortcode Examples
Get header values…
[eacReadme]Contributors[/eacReadme]
[eacReadme]Donate link[/eacReadme]
[eacReadme]Requires at least[/eacReadme]
[eacReadme]Stable tag[/eacReadme]

Get unnamed segments…
[eacReadme]Title[/eacReadme] # gets the '=== plugin name ===' line (before headers)
[eacReadme]Short Description[/eacReadme] # gets the short description (between headers and first section block)

Get section blocks…
[eacReadme]Description[/eacReadme]
[eacReadme]Installation[/eacReadme]
[eacReadme]Screenshots[/eacReadme]
[eacReadme]Changelog[/eacReadme]

Get multiple blocks and/or sub-sections…
[eacReadme plugin='/eacReadme/readme.txt']Short Description,Description[/eacReadme]
[eacReadme plugin='/eacReadme/readme.txt']Short Description,Description/Shortcode Examples[/eacReadme]

Get a file as a code block…
[eacReadme theme='/my-child-theme/functions.js' lang='js']Code File[/eacReadme]
[eacReadme theme='/my-child-theme/style.css' lang='css']Code File[/eacReadme]

Other Options
Change the default cache time-to-live by adding to wp-config.php:
define('EAC_README_CACHE_LIFETIME',$seconds); # default: 1-day (DAY_IN_SECONDS).

Override the default cache time-to-live
[eacReadme ttl=$seconds ...] # minimum: 1-minute (MINUTE_IN_SECONDS).

Set the default GitHub access token (for private repositories):
define('GITHUB_ACCESS_TOKEN',$token);

Set/override the GitHub access token
[eacReadme token=$token ...]

Override option to parse markdown when retrieving a segment
[eacReadme parse='true|false' ...]

Set class=’language-*’ on code blocks
[eacReadme lang='php|js|css|html' ...]

Translating Header/Section Names
Translate header/section names when retrieving All Headers, All Sections, or Document
[eacReadme translate='name=newname,...']
[eacReadme translate='Requires at least=Requires WordPress Version,Screenshots=Screen Shots']

Erase default translation table
[eacReadme translate='no|none|false']

Default translation table
[
'Headers' => 'Document Header',
'Plugin URI' => 'Homepage',
'Stable tag' => 'Current Version',
'Requires at least' => 'Requires WordPress Version',
'Tested up to' => 'Compatible up to',
'Requires PHP' => 'Requires PHP Version',
'WC requires at least' => 'Requires WooCommerce',
'Requires EAC' => 'Requires {eac}Doojigger',
'Changelog' => 'Change Log',
'Screenshots' => 'Screen Shots',
];

Readme Format
{eac}Readme expects a well-formed readme.txt file that follows the WordPress readme file standard…
title
header: value
header: value
short Description

section

= sub-section =

…but supports some extensions to that standard:

Author & Author URI

Author header may be a simple name or a markdown link:

[Author](Author URI).

The Author & Author URI headers, if present, are combined as a markdown [Author](Author URI).

Homepage

Looks for Homepage or Plugin URI.

Version

Looks for Version or Stable tag.

Contributors

profileId – wordpress profile (standard)
[email protected] – gravatar profile
profileId@wordpress – wordpress profile
profileId@gravatar – gravatar profile
profileId@github – github profile
[display name](mailto:[email protected]) or [display name](http://www.gravatar.com/profileId/)
[display name](https://profiles.wordpress.org/profileId/)
[your name]((http://your/profile/url)

A “banner” section may be included between the top title line and the first header line.

title

[](//link_url)
header: value
header: value
short Description

section

= sub-section =

The header block may be enclosed in an html

or

tag, opening and closing each on a single line. These tags are ignored by the eacParseReadme parser but may be beneficial if posting your readme file elseware. See {eac}Readme on Github.

Note: these extensions are not supported by the WordPress Plugin Repository.

{eac}Readme supports standard markdown (readme.md) formatting for section identification.
+ === title === and ## title are equivalent
+ == section == and ### section are equivalent
+ = sub-section = and #### sub-section are equivalent
Output HTML
When retrieving the header block with …
[eacReadme]All Headers[/eacReadme] or `\eacParseReadme::getAllHeaders()`

Or when retrieving all sections with …
[eacReadme]All Sections[/eacReadme] or `\eacParseReadme::getAllSections()`

Or when retrieving the entire document with …
[eacReadme]Document[/eacReadme] or `\eacParseReadme::getDocument()`

Additional html tags and classes are added, including wrapping blocks within a

tags, adding readme-* class names, and adding anchor links.
WordPress Actions
3rd-party actors may load and use the parser class included in {eac}Readme…
do_action('eacReadme_load_parser'); // loads \eacParseReadme static class
if (class_exists('\eacParseReadme'))
{
\eacParseReadme::loadFile($readme,$context);
$html_document = \eacParseReadme::getDocument();
$title = \eacParseReadme::getTitle();
$version = \eacParseReadme::getVersion();
$donations = \eacParseReadme::getHeader('donate_link');
$description = \eacParseReadme::getSection('description');
}= Additional Information =

{eac}Readme is an extension plugin to and requires installation and registration of {eac}Doojigger.
{eac}Readme uses Parsedown 1.7.4, Copyright (c) 2013-2018 Emanuil Rusev

{eac}Readme uses Prism syntax highlighter, Copyright (c) 2012 Lea Verou

The {eac}SoftwareRegistry Software Product Taxonomy plugin uses {eac}Readme to parse readme markdown files hosted on Github to provide plugin information and automated updates to WordPress for self-hosted plugins.

Copyright
Copyright © 2019-2025, EarthAsylum Consulting, distributed under the terms of the GNU GPL.
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should receive a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

各版本下載點

• 方法一：點下方版本號的連結下載 ZIP 檔案後，登入網站後台左側選單「外掛」的「安裝外掛」，然後選擇上方的「上傳外掛」，把下載回去的 ZIP 外掛打包檔案上傳上去安裝與啟用。
• 方法二：透過「安裝外掛」的畫面右方搜尋功能，搜尋外掛名稱「{eac}Doojigger Readme Extension for WordPress」來進行安裝。

（建議使用方法二，確保安裝的版本符合當前運作的 WordPress 環境。

---

1.1.0 | 1.1.1 | 1.2.0 | 1.2.2 | 1.2.3 | 1.2.4 | 1.2.5 | 1.2.6 | 1.3.0 | 1.4.0 | 1.4.1 | 1.4.2 | 1.4.3 | 1.4.4 | 1.4.5 | trunk |

延伸相關外掛（你可能也想知道）

• Github README 》Github README 外掛允許您使用簡單的 shortcode 在頁面或文章中嵌入來自 Github 的 Markdown。, 使用方法：, github_readme, 此 shortcode 嵌入該專案的 READ...。
• Plugin README Parser 》WordPress README 外掛, 這個外掛可以把 WordPress 的 README 檔案使用 Markdown 語言轉換成 XHTML，並顯示在網站上的文章或頁面中。, 對於插件開發人員來說...。
• BNS Theme Add-Ins 》這是一個功能和代碼的集合，可以用來擴展 WordPress 母題和子母題的能力。, * 版權所有 2011-2014 Edward Caissie（電子郵件：[email protected]）, ...。
• SimSage Search Plugin 》SimSage 是一個強大的語意搜索引擎，支援操作員回傳。SimSage 可以幫助您構建一個額外的自然語言知識庫，以進行問答解答。目前 SimSage 僅支持英語。。
• ReadMe Creator 》ReadMe Creator 是一個用於創建 Readme 文件的簡單插件。它提供了一個 HTML 表單，用於創建 readme.txt。詳細信息請查看屏幕截圖。, 功能：, 1. 通過簡單的表...。
• Plugin FAQ Parser 》解析在外掛目錄中的常見問題。, 工作原理, 。
• cbnet Manage Plugins Donate Link 》這個 WordPress 外掛提供了一個快速方便的方式，讓你可以在「管理外掛」頁面的每一個外掛的 plugin_row_meta 中加上「贊助」連結，將外掛作者的贊助連結輕鬆...。
• Brief 》Brief是一個WordPress外掛，可顯示開發報告、說明文件和讀我文件等儀表板小工具，供開發人員提供給客戶。, 該外掛支援markdown格式。開發人員還可以透過組態...。