[WordPress] 外掛分享： WP Contextual Help

前言介紹

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

外掛協作開發者

kevinlangleyjr |

外掛標籤

help | contextual |

內容簡介

為 WordPress 網站的整個管理員區域加入小幫助功能的外掛程式。

使用方法

當您註冊標籤時，您可以有幾個不同的選項來決定該處提供哪些內容。

如果您在標籤參數中提供了回撥函數，它將優先於外掛程式尋找小幫助文件夾內的任何 HTML 檔案。

如果您在標籤參數中提供了文件，則外掛程式將專門尋找該文件，如果該文件不存在，則會輸出一條警告消息，以取代內容，通知開發人員該指定的小幫助文件不存在。

如果沒有傳遞檔案或回撥的參數到標籤中，則預設的外掛程式會尋找與標籤 ID 相同名稱的檔案。例如，對於名為“post-management”的標籤，它將查找小幫助文件夾內的“post-management.html”檔案。

HTML 小幫助文件夾

所有小幫助文件都應該存放在 get_template_directory() . '/includes/help-docs/'; 文件夾內，並且所有圖片都應該存放在 get_template_directory() . '/includes/help-docs/img/'; 文件夾內。

您可以使用 wp_contextual_help_docs_dir 過濾器來更改 HTML 檔案的目錄，並使用 wp_contextual_help_docs_url 過濾器來更改圖片的基本 URL。在您的小幫助文件中，我們使用變數 {WP_HELP_IMG_URL} 作為圖片 URL 的佔位符，然後在呈現之前插入從過濾器提供的值，或默認使用小幫助文件夾內的圖片。

註冊一個標籤

可以使用 WP_Contextual_Help::register_tab() 方法來註冊小幫助標籤。

參數

$id (string) – 將用作小幫助標籤的 ID 的字串
$title (string) – 在標籤內顯示給使用者的標題
$args (array) – 有關小幫助標籤的選項的一個選項陣列

page (string, array) – 啟用小幫助標籤的頁面
post_type (string, array) – 將標籤限制為僅顯示在這些特定文章類型上
file (string) – 要讀取並輸出到標籤內的 HTML 檔案
wpautop (boolean) – 預設：False - 對載入的 HTML 檔案應用 wpautop
callback - 如果用戶希望使用自訂回撥函數代替 HTML 檔案的自動載入，則可以在此處應用該函數

範例
array( 'post.php', 'post-new.php' ), 'post_type' => 'post', 'wpautop' => true ) ); // 添加到自定義管理頁面 WP_Contextual_Help::register_tab( 'custom-settings', 'Custom Settings', array( 'page' => 'settings_page_custom-settings-page', 'wpautop' => true ) ); // 添加帶有自定義回撥函數的小幫助標籤 WP_Contextual_Help::register_tab( 'custom-callback', 'Custom Callback Example', array( 'page' => array( 'post.php', 'post-new.php' ), 'post_type' => 'post', 'callback' => function( $screen, $tab ) { echo '

It is super easy to add new help tabs!

'; } ) ); } ); ?>

原文外掛簡介

Adds helper functionality to easily add to the WP Contextual Help throughout the admin of a WordPress site.
Usage
When you register a tab you have a few different options as far as what content is displayed there.
If you provide a callback argument in the tab args, that will take precedence and the plugin will not look for any HTML files within the help-docs directory.
If you provide a file argument in the tab args, the plugin will look for that file specifically and if it does not exist will output a warning message in place of the content to notify the developer that the specified help document does not exist.
If no file or callback argument is passed into the tab args, by default the plugin will look for a file with the same name as the id of the tab. So for post-management it would look for post-management.html within the help docs directory.
HTML Help Docs
All help docs should either reside within the get_template_directory() . '/includes/help-docs/'; directory and all images within the get_template_directory() . '/includes/help-docs/img/';
You can use the wp_contextual_help_docs_dir filter to change the directory for the HTML files and the wp_contextual_help_docs_url filter to change the base URL for the images. Within your help documentation we use the variable {WP_HELP_IMG_URL} as a placeholder for the image URL which is then replaced before rendering with the value provided from the filter or defaults to the default help docs image directory.
Registering a tab
Help tabs are registered using the WP_Contextual_Help::register_tab() method.
Parameters

$id (string) – String to be used as the ID for the help tab
$title (string) – Title to display to the user within the tab
$args (array) – An array of options for the help tab

page (string, array) – Page(s) to enable the help tab
post_type (string, array) – Limit the tab to only display on these specific post types
file (string) – HTML file to read and output within the tab
wpautop (boolean) – Default: False – Apply wpautop to the loaded HTML file
callback – If a user would rather a custom callback instead of the autoloading of a HTML file, this is where that would be applied

Example
array( 'post.php', 'post-new.php' ), 'post_type' => 'post', 'wpautop' => true ) ); // Add to a custom admin page WP_Contextual_Help::register_tab( 'custom-settings', 'Custom Settings', array( 'page' => 'settings_page_custom-settings-page', 'wpautop' => true ) ); // Add help tab with custom callback WP_Contextual_Help::register_tab( 'custom-callback', 'Custom Callback Example', array( 'page' => array( 'post.php', 'post-new.php' ), 'post_type' => 'post', 'callback' => function( $screen, $tab ) { echo '

It is super easy to add new help tabs!

'; } ) ); } ); ?>

各版本下載點

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

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

---

0.0.1 | 0.0.2 | 0.0.3 | 1.0.0 | 1.0.1 | 1.0.2 | 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 》, , , , , , , ...。