Documentation

Documentation provides sound structures and tools to maintain a Documentation Management System based on WordPress.

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.

See our documentation portal for an example where we use the system to maintain a considerable amount of documentation for our tools. Simple to use, yet powerful to maintain even thousands of documentation pages.

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
  • Document Categories : to display links to document categories

Shortcodes

The following shortcodes are available:

  • [documentation_documents] Lists documents, also useful to list documents in a category.
  • [documentation_categories] Renders a list of links to the document categories.
  • [documentation_hierarchy] Provides a means to navigate the documentation structure, equivalent to the Document Hierarchy widget.
  • [documentation_list_children] Lists the children of a document like the Document Children widget.
  • [documentation_search_form] Renders a dynamic search form. Use Search Live for a more flexible search form.

Recommended Useful Additions

You should have a look at these tools. They will help you get the most out of this Documentation Management System.

  • WooCommerce Documentation This extension for WooCommerce and the Documentation plugin for WordPress allows to link documentation pages to products and display them automatically on the product pages.
  • Groups Groups is designed as an efficient, powerful and flexible solution for group-oriented memberships and content access control. Use it to control who can view documents and more.
  • Groups Restrict Categories An extension based on Groups, provides access restrictions for categories and tags, custom post types and taxonomies. Very useful to restrict whole sets of documents based on their document categories or tags.
  • Search Live Search Live supplies effective integrated live search facilities and advanced search features. Makes it really easy to find the desired documents.
  • Widgets Control Widgets Control is a toolbox that features visibility management for all widgets, sidebars, sections of content and content blocks. This is very useful to show content and widgets in context.
  • Widgets Control Pro Widgets Control Pro is the advanced version of the Widgets Control toolbox that features visibility management for all widgets, sidebars, sections of content and content blocks. With its additional features, it is even more useful to show document-specific content and widgets, including the options to show widgets on documents and related pages only.
  • Decent Comments Decent Comments shows what people say. If you want to show comments along with their author’s avatars and an excerpt of their comment, then this is the right plugin for you. Use it to show comments posted on documents only or including them.
  • Open Graph Protocol Framework The Open Graph protocol enables any web page to become a rich object in a social graph. For instance, this is used on Facebook to allow any web page to have the same functionality as any other object on Facebook. This will automate the process of adding basic and optional metadata to documents.

Documentation

Please refer to the documentation pages for details. The site uses the Documentation plugin and is a good example of deployment, with an extensive set of documentation sections and pages.

Download

You can download the plugin or install it directly from your WordPress dashboard. Go to Plugins > Add New, search for documentation and click Install Now for the Documentation plugin.

 

Screenshots

39 Responses to Documentation

  1. Kathy September 7, 2019 at 3:14 pm #

    Hi I love this plugin but im wondering if instead of the link going to a post page there is away to open the file link directly. I would be willing to pay for this feature as I just cant find a simple documents manager like yours. Hope you can help

    • Kento September 9, 2019 at 10:16 am #

      Hi Kathy,

      Thanks for your kind comment on the plugin, I will get in touch with you as we would need to pinpoint the exact requirements that you have in mind.

      Cheers

  2. Jeroen March 2, 2016 at 9:05 pm #

    Hi,

    For a long time I’ve been using this great plugin without any problem. Ive updated the other day this plugin, and today I found out that the message “There are no documents” appears inside the widgets.

    No idea what happened here. All my documents self are still there. But they aren’t shown inside the widget.

    http://feeny.nl/support/
    http://feeny.nl/document/de-instellingen-van-een-formulier/

    • antonio March 4, 2016 at 8:27 am #

      Hi Jeroen,
      please update to the last version.
      Thanks for the feedback.
      Kind Regards,
      Antonio B.

  3. Jeroen March 1, 2016 at 9:03 pm #

    Hi,

    For a long time I’ve been using this great plugin without any problem. Ive updated the other day this plugin, and today I found out that the message “There are no documents” appears inside the widget.

    No idea what happened here. All my documents self are still there (I can see them in the dashboard). But they aren’t shown inside the widget.

    http://feeny.nl/support/
    http://feeny.nl/document/de-instellingen-van-een-formulier/

  4. Pablo November 18, 2015 at 12:09 pm #

    Hi!, i need to convert from documents to pages format, and I need to make bulk conversions, but i can’t find the way. Please, I need your help urgently.

    Thanks

    • Kento November 18, 2015 at 12:18 pm #

      Hi Pablo,

      There are plugins that can help you to convert from one post type to another, have a look at this search convert post type.

      I highly recommend to test it on a staging site first before you make the conversion on your production site. Also make absolutely sure to make a FULL BACKUP of your site and your database before running any conversion.

      Cheers

  5. June April 11, 2015 at 6:29 am #

    hello,
    I’m testing your plugin, but I found one small issue, that’s 404 issue.
    I have to add some code to flush rewrite rules into your plugin for plugin activation and save option logic by myself.
    I think you’d better add it too. Because many people don’t know the reason.
    Thanks
    June

    • kento April 17, 2015 at 11:05 am #

      Hi June,

      Thanks for pointing that out. Could you provide a patch to review it please?

      Cheers

  6. Herb January 14, 2015 at 6:20 am #

    I am using the Karma theme and installed the documentation plug in. When I add a document and view it, it uses the Blog page format which has a blog sidebar. I want to use a different sidebar with the document widgets. How can I do this?
    Thanks in advance for your help.

    • kento January 14, 2015 at 6:21 pm #

      Hi Herb,

      You could create templates for the document post type, see
      Post Type Templates
      for more info on how that is done please. For a document page, you would create a single-document.php in your theme.

      Cheers

  7. Toni October 31, 2014 at 4:54 am #

    Is there a way to bulk upload documents?

    • kento November 4, 2014 at 9:03 pm #

      No but thanks for the suggestion, in the case of this plugin a bulk import feature might be a good idea.

  8. Toni October 30, 2014 at 10:00 pm #

    I have installed but not used the plugin yet. I have questions firsts – I don’t create a mess. For once. You probably have this documented – I have been searching plugins for ever and I am brain-toast right now.

    I have a multisite. As suggested, I dedicated a subsite for documents. I have quite a few docs – 350 plus, so far. They are just for downloading and printing – nothing collaborative, etc.

    1.) Lazy: Do I need to upload docs one by one, and fill out boxes of info one doc at a time and categorize? Or can I mass upload and deal with the details later? The files are all properly named.

    2.) Flexibility: Once I have upload files am I able to “move” them around? From one category, or under a parent-file, etc., to another easily?
    After I create links to docs on my main site – will it be problematic if I need to rearrange files as I mentioned above?

    Note: I had started with the Media Library, then other media plugins, and it has been hellish. I am asking before I start a load of work again. Thank you.
    Cheers!

    • kento November 4, 2014 at 9:02 pm #

      Hi Toni,

      This plugin provides Documents etc as a custom post type, from what you describe I don’t think it’s a match because you seem to want to upload a bunch of documents which users should be able to access or download.

      If you have a quick look at the Documentation for this plugin you’ll understand what it’s about 😉

      Cheers

  9. Randy Minton September 7, 2014 at 6:45 pm #

    I am trying to build a document repository. Users would submit a paper (journal article) securely and have the ability to revise the article (up to some specific point in time). Ideally, they would receive a document number since theoretically they could submit more than one unique, unrelated document. Does this sound like an application for which your plugin might be suitable?

    • kento September 10, 2014 at 1:45 pm #

      Hi Randy,

      Thanks for asking, I think yes and you could use Groups to allow users to submit documents by setting up a group with the appropriate capabilities.

  10. Li Fitzmaurice July 18, 2014 at 10:48 am #

    I tried to use Document Child widget. It asks for document ID. I know which document I want to show its children, but cannot figure out how to find its ID.

    Could you please let me know? Thanks.

    • kento July 18, 2014 at 7:01 pm #

      Hi, if you go to Documents > All Documents and check the URL for the Edit button of a document, you will see it looks like this http://www.example.com/wp-admin/post.php?post=123&action=edit – in this case the ID is 123. You can also click that link and get it from the URL bar in your browser if it doesn’t appear in the info bar of the browser when you hover over the link.

  11. Dan April 8, 2014 at 6:15 pm #

    I might have missed something in the documentation or thr plugin isn’t working as I expected.

    I can create a document and not apply any rights to it but none of the other users can see / edit the document from documents => all.

    Is this normal?

    • kento April 15, 2014 at 3:49 pm #

      Hi Dan, do you have any plugin installed that restricts access by content type?

  12. Klaus March 12, 2014 at 8:34 pm #

    Any chance that you will release a .po file? If I dont find another plugin to handle my document I would like to do a danish translation.

    • kento March 15, 2014 at 5:53 pm #

      Hi Klaus,

      Please download this translation template based on the current version and use it to create your translation. If you could contribute your translation back we can add it to the plugin itself.

      Cheers

  13. Dennis February 4, 2014 at 8:05 pm #

    I installed this plugin for a client, without getting the full grasp of their needs. They have 300 documents. They want to show in a widget, categories as drop downs, then the docs from that category show as a list. Is this possible?

    • kento February 5, 2014 at 10:52 am #

      Hi Dennis,

      That’s an interesting idea. There are a few plugins out there that seem to get close to what you describe for posts and categories, but from what I’ve seen they don’t support custom post types and taxonomies in general (which they would need to for this case).

      It may well be worth considering to create a plugin which works with the latest WordPress version, the ones I’ve seen don’t seem to be quite up-to-date.

  14. Jeroen January 25, 2014 at 11:40 am #

    I’ve noticed that there are 2 shortcodes: [documentation_hierarchy] This is the shortcode-equivalent to the Document Hierarchy widget. And [documentation_list_children] This is the shortcode-equivalent to the Document Children widget.

    But is there a shortcode-equivalent for the widget: Documents? I’d like to show the documents in an overview page, based upon their categories.

    Category A
    – doc 1
    – doc 2

    Category B
    – doc 1
    – doc 3
    – doc 4

    Would be awesome if this is possible!

    • kento January 27, 2014 at 9:41 am #

      Good idea! I’ll add the shortcode when possible. Meanwhile this might help?

      • Jeroen January 27, 2014 at 10:15 am #

        Hi Kento!

        Thanks for your reply. I’ve tried your suggestion in various ways like

        [documentation_category id=”170″]
        [document_category category=170]
        [document_category tag_ID=”Agenda” post_type=”document”]
        etc.

        But nothing seemed to do anything. Do you have any idea what could work?

        • kento January 27, 2014 at 10:28 am #

          What happens is that these shortcodes don’t exist 🙂 The ones that you can currently use are those documented here.

          • Jeroen January 27, 2014 at 11:11 am #

            Duh! It”s clearly a monday morning…

            I’ve installed that plugin and tried variations on

            [display-posts post_type=”document” ]
            [display-posts post_type=”document” document_category=”Agenda” ]
            [display-posts document_category=”Agenda” ]

            The first two do show the post made with Documentation, but it’s both a list of the 10 latest posts i’ve written in Documentation.
            The last shortcode shows the last 10 posts i’ve written for my blog.

            So it seems that the category isn’t found. I’ve tried also category=”Agenda” and category=”170″, but then nothing was shown.

            • kento January 29, 2014 at 1:53 pm #

              😀 ok

              I would assume this attribute needs to be post_category?

          • Jeroen January 30, 2014 at 11:32 am #

            Just also tried that. Or I’m doing something really wrong here, or display-posts just doesn’t work.

            Whatever I try I only get an overview of all the latest posts ive written in Documentation.

            • kento February 1, 2014 at 11:21 am #

              I’d suggest to ask that plugin’s author if he can help with this. I’m not really familiar with the extent of the shortcodes it provides.

          • Jeroen February 2, 2014 at 2:27 pm #

            Yep, will try to do that.

            But I can also take your word “I’ll add the shortcode when possible”? 😉

      • Danika September 28, 2016 at 6:32 am #

        Hi Kento,

        Did this shortcode ever get implemented? I also want to be able to display my documents grouped my category.

        Thanks.

  15. Alan Kellogg January 25, 2014 at 12:34 am #

    It worked!

  16. Alan Kellogg January 22, 2014 at 11:52 pm #

    Unfortunately, after posting a page when ever I click on “go to document” I get a 404>

    • kento January 24, 2014 at 12:49 pm #

      Try getting the permalink structure updated. Go to Settings > Permalinks, this will update the permalinks and the pages should be available.

Leave a Reply

We use cookies to optimize your experience on our site and assume you're OK with that if you stay.
OK, hide this message.

Affiliates · Contact · Jobs · Terms & Conditions · Privacy Policy · Documentation · Downloads · Useful Plugins · My Account

Share