[WordPress] 外掛分享: WP Screen Help Loader

前言介紹

  • 這款 WordPress 外掛「WP Screen Help Loader」是 2016-01-02 上架。
  • 目前尚無安裝啟用數,是個很新的外掛。如有要安裝使用,建議多測試確保功能沒問題!
  • 上一次更新是 2016-01-03,距離現在已有 3408 天。超過一年沒更新,安裝要確認版本是否可用。以及後續維護問題!
  • 外掛最低要求 WordPress 4.4 以上版本才可以安裝。
  • 尚未有人給過這款外掛評分。
  • 還沒有人在論壇上發問,可能目前使用數不多,還沒有什麼大問題。

外掛協作開發者

meitar |

外掛標籤

help | screen |

內容簡介

這個外掛可讓您在 WordPress 管理後台的內建「說明」選單上新增自訂說明標籤或額外的側邊欄內容,只需將說明檔案放在特定資料夾即可。擴充功能是透過尋找您目前佈景主題中 admin-help/ 資料夾中的檔案,並根據檔案名稱將內容新增至 WordPress 說明系統的畫面上。檔案應以 Markdown 撰寫。

您可以增強任何畫面的說明標籤或側邊欄內容,包括其他外掛創建的屏幕。檔名決定了將內容新增至 WordPress 管理區域中的哪個畫面。

您可以使用任何語言編寫說明內容,外掛會自動載入您網站的正確語言檔案,因此翻譯說明內容非常容易。

例如,如果您經營一個英語網站,想要增強 WordPress 核心或用戶個人資料編輯頁提供的內建說明,只需在 YOUR_THEME/admin-help/en_US/profile.md (其中 YOUR_THEME 是佈景主題資料夾) 增加一個檔案即可。(對於西班牙語網站,請在 YOUR_THEME/admin-help/es_ES/profile.md 中增加檔案)。

外掛用於判斷在哪個畫面上載入哪個檔案時,採用以下規則:

每個說明檔案都包含在與 WordPress 安裝的區域字串匹配的目錄中。通過更改 WordPress 語言設置來控制區域字串。
檔名引用 WP_Screen 類的 $action 和 $id 成員。
檔案可以選擇性地以數字優先順序作為後綴 (較低的數字優先顯示,高於具有較大數字的文件的內容,如WP_Screen文件的內容)。
檔案可以選擇性地以 sidebar- 為前綴,表示該檔案包含的內容適用於說明側邊欄而不是自己的標籤頁面。
特殊檔名 sidebar.md 會追加到顯示屏幕說明的每個 WordPress 管理畫面頁面上的側邊欄。

針對外掛或佈景主題作者

要在您的外掛中使用 WP Screen Help Loader,您只需:

function my_plugin_add_custom_help () {
new WP_Screen_Help_Loader(plugin_dir_path(__FILE__) . 'help');
}
add_action('admin_head', 'my_plugin_add_custom_help');

現在將本地化的說明內容放入您的外掛目錄中的 help/YOUR_LANGUAGE 目錄中即可。就是這樣!
如果您喜歡這個外掛,請考慮捐贈以支持這個外掛,或購買Meitar的網頁開發書籍或直接貢獻給Meitar的Cyberbusking基金。(出版費)

原文外掛簡介

Make your site’s on-screen admin help tabs more helpful by adding custom help tabs or additional sidebar content to any screen of the WordPress Admin Dashboard’s built-in “Help” menu simply by placing help files in a special folder.
This plugin looks for files located in your current theme’s admin-help/ folder and, based on their name, adds their content to the WordPress on-screen help menuing system. The files should be written in markdown.
You can augment any screen’s help tabs or help sidebar, including screens created by other plugins. The name of the help file determines which screen in the WordPress admin area the file’s content will be added to.
You can add help content in any language, and the plugin will automatically load the correct language file for your site. This makes translating help content easy.
For instance, if you run an English website and want to augment the built-in help provided by WordPress core or a custom plugin shown on the user’s profile editing page, add a file at YOUR_THEME/admin-help/en_US/profile.md, where YOUR_THEME is the theme folder. (For a Spanish site, add a file to YOUR_THEME/admin-help/es_ES/profile.md.)
The rules used by the plugin to determine which file to load on which screen are as follows:

Each help file is contained within a directory matching the locale string of the WordPress installation. Control the locale string by changing the WordPress language setting.
File names reference the $action and $id members of the WP_Screen class.
Files can be optionally suffixed with a numeric priority (lower numbers display first, above the content of files with larger numbers as per WP_Screen documentation).
Files can be optionally prefixed with sidebar- indicating that the file contains content intended for the help sidebar rather than a tab of its own.
The special filename sidebar.md is appended to the sidebar on every WordPress admin screen page where on-screen help is shown.

For plugin or theme authors
To use WP Screen Help Loader in your plugin, all you need to do is:
function my_plugin_add_custom_help () {
new WP_Screen_Help_Loader(plugin_dir_path(__FILE__) . 'help');
}
add_action('admin_head', 'my_plugin_add_custom_help');

Now put your localized help contents into the help/YOUR_LANGUAGE directory in your plugin directory. That’s it!
If you like this plugin, please consider making a donation for your use of the plugin, purchasing one of Meitar’s web development books or, better yet, contributing directly to Meitar’s Cyberbusking fund. (Publishing royalties ain’t exactly the lucrative income it used to be, y’know?) Your support is appreciated!

各版本下載點

  • 方法一:點下方版本號的連結下載 ZIP 檔案後,登入網站後台左側選單「外掛」的「安裝外掛」,然後選擇上方的「上傳外掛」,把下載回去的 ZIP 外掛打包檔案上傳上去安裝與啟用。
  • 方法二:透過「安裝外掛」的畫面右方搜尋功能,搜尋外掛名稱「WP Screen Help Loader」來進行安裝。

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


0.1 | trunk |

延伸相關外掛(你可能也想知道)

  • WP101 Video Tutorial Plugin 》WP101® Video Tutorial Plugin 是教授客戶 WordPress 基礎知識最簡單的方式,讓您的支援成本減少並為客戶提供寶貴的資源。它提供一系列專業製作的 WordPress ...。
  • WP Help 》網站管理員可以為網站的作者、編輯和貢獻者建立詳細的階層式文件,可在 WordPress 管理員中查看。利用自定義文章類型,您可以利用 WordPress 的所有功能來創...。
  • WP Support Plus Responsive Ticket System 》這個外掛是為了現有的使用者而維護的。我們強烈建議新使用者使用我們最新的票務系統 SupportCandy。。
  • Text Hover 》這個外掛可以讓你輕鬆定義當訪客在文章或頁面上懸停滑鼠在單詞或短語上時出現的説明文字。, 透過外掛的設置,只需要指定你想要與懸停文字關聯的單詞或短語,...。
  • DocsPress – Online Documentation 》此外掛提供您的多個產品的線上文件。在 WordPress 網站上建立、主持和管理文檔。, 連結, , 即時 demo, GitHub, , 功能特色, , 支援多個產品, AJAX 搜尋, AJAX...。
  • Intro Tour Tutorial DeepPresentation 》這個 WordPress 外掛提供了一個直覺式的導覽功能,可以引導使用者遊覽你的網站或協作同事透過 WordPress 管理介面管理你的網站。你可以自由選擇導覽的開始方...。
  • Admin Help Docs 》網站開發人員和管理員可以輕鬆為管理區域創建幫助文檔和通知。可以包含有關指令的幫助部分或在後台的任何位置添加幫助框(請參閱下面的網站位置和頁面位置)...。
  • DocuPress 》, , DocuPress 可在 WordPress 控制台中直接幫助您創建自己的文件。, 將文章分為集合,使用戶輕鬆瀏覽他們正在查找的內容。, 小工具和短碼, DocuPress 包括[d...。
  • Better Admin Help Tabs 》這個外掛可以在 WordPress 管理區域的任何頁面上創建管理員幫助標籤(以及相關的側邊欄)。它創建了一個名為「Help Tabs」的自訂文章類型來存儲信息。您需要...。
  • Help Manager 》網站操作員可以創建詳細的階層式文件,供網站的作者、編輯和貢獻者查看。使用自訂文章類型,您可以使用WordPress所有功能來創建、編輯和排列文檔。非常適合客...。
  • Tips Shortcode 》新增短代碼,可在任何文章或頁面中顯示提示框。只需使用 [tip] [/tip] 短代碼將文字放入提示框中即可。, 您可以使用 color 屬性更改提示框的顏色。所以,要將...。
  • SH Contextual Help 》通過這個外掛,您可以簡單地修改 WordPress 默認幫助內容或自訂文章類型的幫助內容,同時增加一個自定義幫助指南的選單。您還可以添加儀表板小部件,這個外掛...。
  • Admin Expert Mode 》WordPress長期以來一直在管理界面中提供內嵌文檔,針對各種功能和輸入欄位進行說明,包括摘錄、引用、自定義欄位、頁面父類別等等。對於WordPress新手而言,...。
  • UVdesk Free Helpdesk for WordPress 》Uvdesk 是一個全渠道幫助台,透過不同的水平媒體提供快速協助,僅需要快速註冊即可提供您頻道的優質客戶支援。, 眾多應用程式整合 – https://support.u...。
  • WC Donation Manager – Effortlessly Collect Donations Through WooCommerce 》, , , Donation Manager for WooCommerce, , , , ...。

文章
Filter
Apply Filters
Mastodon