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!

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. 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 '<a href="mailto:person@agency.site">Contact us!</a>';
}, 10, 1 );

ਸਕਰੀਨਸ਼ਾਟ

  • Documentation widget on the main dashboard.
  • Documentation page including the select/upload buttons.
  • Default view for the Glossary
  • 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!

ਸਮੀਖਿਆਵਾਂ

There are no reviews for this plugin.

ਯੋਗਦਾਨੀ ਤੇ ਵਿਕਾਸਕਾਰ

“WDS Site Documentation” is open source software. The following people have contributed to this plugin.

ਯੋਗਦਾਨੀ

“WDS Site Documentation” ਦਾ ਆਪਣੀ ਭਾਸ਼ਾ ਵਿੱਚ ਅਨੁਵਾਦ ਕਰੋ।

ਵਿਕਾਸ ਕਾਰਜ ਵਿੱਚ ਰੁਚੀ ਰੱਖਦੇ ਹੋ?

Browse the code, check out the SVN repository, or subscribe to the development log by RSS.

ਤਬਦੀਲੀ-ਚਿੱਠਾ

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