Documentation

Description

Documentation is intended to provide sound basic structures for a documentation management system.

Leveraging WordPress’ framework and internal structures, the system provides a completely new section to manage documents independently from normal posts or pages.
Documents are complemented by their dedicated document categories and document tags, which allows to keep the documentation structures separate from the more blog-oriented posts or CMS-like pages.
It can be used to build a dedicated documentation site, a subsite for documentation in a multisite network or other creative deployments.

Documents can be attached to products in WooCommerce using WooCommerce Documentation.

Widgets

The plugin provides several widgets that are used to display document links:

  • Document Hierarchy : facilitates navigating and viewing the document hierarchy
  • Document Children : displays links to children of documents
  • Documents : to display sets of document links

Shortcodes

The following shortcodes are available:

  • [documentation_hierarchy]
  • [documentation_list_children]
  • [documentation_search_form]
  • [documentation_documents]

Please refer to the documentation pages for details.

Feedback

Feedback is welcome!

If you need help, have problems, want to leave feedback or want to provide constructive criticism, please do so here at the Documentation plugin page.

Please try to solve problems there before you rate this plugin or say it doesn’t work. There goes a lot of work into providing you with free quality plugins! Please appreciate that and help with your feedback. Thanks!

Twitter

Follow @itthinx on Twitter for updates on this and other plugins.

Screenshots

  • Documents Menu
  • Example documentation as viewed on the back end.
  • Document Hierarchy widget settings
  • Document Hierarchy widget example output
  • Document Children widget settings
  • Document Children widget example output
  • Documents widget settings
  • Documents widget example output
  • [documentation_hierarchy] shortcode example output

Installation

  1. Upload or extract the documentation folder to your site’s /wp-content/plugins/ directory. You can also use the Add new option found in the Plugins menu in WordPress.
  2. Enable the plugin from the Plugins menu in WordPress.

FAQ

Where is the documentation?

The documentation pages are here.

Reviews

Read all 7 reviews

Contributors & Developers

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

Contributors

Changelog

1.4.0

  • WordPress 4.7.2 compatibility tested.
  • Improved handling of number of documents shown for Documents widget.
  • Added the [documentation_categories] shortcode.

The full changelog is available at https://github.com/itthinx/documentation/blob/master/changelog.txt