Title: WDS Site Documentation Author: webdevstudios Published: 2021 年 3 月 25 日 Last modified: 2024 年 6 月 5 日 --- 搜索插件 ![](https://ps.w.org/wds-site-documentation/assets/banner-772x250.png?rev=2744396) **该插件尚未通过WordPress的最新3个主要版本进行测试**。 当与较新版本的WordPress一起 使用时，可能不再受到维护或支持，并且可能会存在兼容性问题。 ![](https://ps.w.org/wds-site-documentation/assets/icon-256x256.png?rev=2744396) # WDS Site Documentation 作者：[webdevstudios](https://profiles.wordpress.org/webdevstudios/) [下载](https://downloads.wordpress.org/plugin/wds-site-documentation.1.1.1.zip) * [详情](https://cn.wordpress.org/plugins/wds-site-documentation/#description) * [评价](https://cn.wordpress.org/plugins/wds-site-documentation/#reviews) * [安装](https://cn.wordpress.org/plugins/wds-site-documentation/#installation) * [开发进展](https://cn.wordpress.org/plugins/wds-site-documentation/#developers) [支持](https://wordpress.org/support/plugin/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](https://webdevstudios.com/)! ### Web Glossary Empower your clients with a comprehensive understanding of their WordPress website. The WDS Site Documentation plugin now includes a brand new Web Glossary featuring approximately 70 essential website terms. This user-friendly glossary equips your clients with the following: * An easy-to-comprehend definition * Real-world examples * An explanation of why the term is important * And what the term is commonly confused with Help your clients unravel any vagueness surrounding website management. Each glossary term boasts its own dedicated page, providing in-depth breakdowns to solidify their knowledge. No more mistaking one term for another. The new WDS Site Documentation Web Glossary clarifies any potential ambiguities. Suggest a web glossary term by emailing [support@pluginize.com](https://cn.wordpress.org/plugins/wds-site-documentation/support@pluginize.com?output_format=md). Suggested web glossary terms must include definitions. ### 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 'Contact us!'; }, 10, 1 ); ``` ## 屏幕截图 [⌊Documentation widget on the main dashboard.⌉⌊Documentation widget on the main dashboard.⌉[ Documentation widget on the main dashboard. [⌊Documentation page including the select/upload buttons.⌉⌊Documentation page including the select/upload buttons.⌉[ Documentation page including the select/upload buttons. [⌊Default view for the Glossary⌉⌊Default view for the Glossary⌉[ Default view for the Glossary [⌊View of a chosen Glossary term.⌉⌊View of a chosen Glossary term.⌉[ View of a chosen Glossary term. ## 安装 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!](https://webdevstudios.com/contact/) ## 评价 此插件暂无评价。 ## 贡献者及开发者 「WDS Site Documentation」是开源软件。 以下人员对此插件做出了贡献。 贡献者 * [ webdevstudios ](https://profiles.wordpress.org/webdevstudios/) * [ Evan Hildreth ](https://profiles.wordpress.org/oddevan/) [帮助将「WDS Site Documentation」翻译成简体中文。](https://translate.wordpress.org/projects/wp-plugins/wds-site-documentation) ### 对开发感兴趣吗? 您可以[浏览代码](https://plugins.trac.wordpress.org/browser/wds-site-documentation/)， 查看[SVN仓库](https://plugins.svn.wordpress.org/wds-site-documentation/)，或通过 [RSS](https://plugins.trac.wordpress.org/log/wds-site-documentation/?limit=100&mode=stop_on_copy&format=rss) 订阅[开发日志](https://plugins.trac.wordpress.org/log/wds-site-documentation/)。 ## 更新日志 #### 1.1.1 * Fixed: Capitalization of “WordPress”. * Updated: Screenshots #### 1.1.0 * Added: Glossary tab to browse and view terms, including filtering or all on one page. * Added: Definitions for common WordPress and website words and phrases. * Added: Ability to filter in your own terms. #### 1.0.2 * Confirmed WordPress 6.0 compatibility #### 1.0.1 * Fixes formatting issues in the README #### 1.0 * Initial release ## 额外信息 * 版本 **1.1.1** * 最后更新：**2 年前** * 活跃安装数量 **10+** * WordPress 版本 ** 5.2 或更高版本 ** * 已测试的最高版本为 **6.5.8** * PHP 版本 ** 7.4 或更高版本 ** * 语言 * [English (US)](https://wordpress.org/plugins/wds-site-documentation/) * 标签 * [documentation](https://cn.wordpress.org/plugins/tags/documentation/) * [高级视图](https://cn.wordpress.org/plugins/wds-site-documentation/advanced/) ## 评级 尚未提交反馈。 [Your review](https://wordpress.org/support/plugin/wds-site-documentation/reviews/#new-post) [查看全部评论](https://wordpress.org/support/plugin/wds-site-documentation/reviews/) ## 贡献者 * [ webdevstudios ](https://profiles.wordpress.org/webdevstudios/) * [ Evan Hildreth ](https://profiles.wordpress.org/oddevan/) ## 支持 有话要说吗？是否需要帮助？ [查看支持论坛](https://wordpress.org/support/plugin/wds-site-documentation/)