该插件尚未通过WordPress的最新3个主要版本进行测试。 当与较新版本的WordPress一起使用时,可能不再受到维护或支持,并且可能会存在兼容性问题。

WDS Site Documentation

描述

Host documentation for your clients right where they need it most: on the website! This plugin creates a page on the WordPress dashboard called “Documentation” that shows a video and links to a PDF.

Brought to you by the fine folks at WebDevStudios!

Filters for developers

The URLs for the movie and PDF files can be modified with the wds_documentation_video_url and wds_documentation_pdf_url filters respectively. For example:

add_filter( 'wds_documentation_pdf_url', function( $pdf_url ) {
    return 'https://agency.site/docs/client.pdf';
}, 10, 1 );

The upload buttons can be turned off with the filter wds_documentation_enable_changes. To turn off the buttons, add this code to your theme’s functions.php file:

add_filter( 'wds_documentation_enable_changes', '__return_false', 10 );

The banner image can be modified with wds_documentation_banner_url:

add_filter( 'wds_documentation_banner_url', function( $banner_url ) {
    return 'https://agency.site/docs/agency.png';
}, 10, 1 );

The footer text can be customized with wds_documentation_footer:

add_filter( 'wds_documentation_footer', function( $footer ) {
    return '<a href="mailto:person@agency.site">Contact us!</a>';
}, 10, 1 );

屏幕截图

  • This shows the documentation widget on the main dashboard.
  • This shows the documentation page including the select/upload buttons.

安装

  1. Upload the plugin to the /wp-content/plugins/ directory
  2. Activate the plugin through the ‘Plugins’ menu in WordPress
  3. Click the “Site Documentation” button in the Admin Bar or under “Settings” to view the documentation page.
  4. Upload a Video and PDF using the buttons there. These will show up on the page and on the WordPress dashboard.

常见问题

Why should I use this?

When an agency hands a site off to the client, they should also provide documentation on how to use the site, even if the site is mostly “vanilla WordPress.” This plugin makes it easy to set up a documentation section in the WordPress dashboard.

Can I turn off the buttons so the documentation can’t be changed accidentally?

Absolutely! See the “Filters for developers” section.

Can I change the banner and footer on the page/widget?

Yes, you can! See the “Filters for developers” section.

Can you build my site?

Absolutely. Drop us a line!

评价

此插件暂无评价。

贡献者及开发者

“WDS Site Documentation” 是开源软件。 以下人员对此插件做出了贡献。

贡献者

将“WDS Site Documentation”翻译成您的语言。

对开发感兴趣吗?

您可以浏览代码,查看SVN仓库,或通过RSS订阅开发日志

更新日志

1.0.2

  • Confirmed WordPress 6.0 compatibility

1.0.1

  • Fixes formatting issues in the README

1.0

  • Initial release