Organized Docs WordPress Plugin

Quick Start Guide

After activating the Organized Docs plugin, you can immediately begin adding Docs articles.

  1. Add a Docs article (documentation article) by going to “Docs –> Add New“. Create your article like you would any post.
  2. When you’re ready to publish, it’s important to choose the correct category for each Docs post. Choose a category from the “Docs Categories” box, or create a new Docs category.

    To choose a category: In the Categories meta box, put a checkmark next to the correct category (or CHILD-category).

    To create a new Docs category:

    • To create a main Product category, click the “Add New Docs Category” link, type the name, and click the “Add New Docs Category” button.
    • To create a child-category (this would be a sub-heading in the Table of Contents), click the “Add New Docs Category” link, type the name, select the parent category that this sub-heading belongs under, then click the “Add New Docs Category” button.
  3. Optional: you can set a custom sort-order number for this post. This will order it under its Sub-heading. Number 1 will appear first, while greater numbers appear lower. Numbers do not have to be consecutive; for example, you could number them like, 10, 20, 35, 45, etc. This would leave room in between to insert new Docs later without having to change all current numbers.
  4. Click “Publish” or “Update“. (or “Save Draft” if not ready to go live).

That’s all. Add as many Docs following these steps, and they will get automatically organized into the Docs Table of Contents.

This is an example how a single doc will look:

Organized Docs - Single Post with Table of Contents sidebar
  

To show the main Docs page on the front of your site, you will need to add that page to your site’s menu. To add the main Docs page to your site’s menu, please see this.

  

Updated on March 5, 2017

We've 2 Responses

  1. December 16th, 2014 at 2:55 am

    Is there any way to assign Doc categories to existing posts? I have a fairly large existing set of articles posted that I would like to show up in a table of contents. Does your plugin work with only new articles?

    avatar
    • December 16th, 2014 at 9:47 pm

      Yes, Docs have to be created as “Docs” post types for this plugin. Docs are a custom post type, not regular posts. But, there are many Table of Contents plugins available that will organize your existing posts, here.

      avatar

Questions and Comments are Welcome

Your email address will not be published. All comments will be moderated.

Please wrap code in "code" bracket tags like this:

[code]

YOUR CODE HERE 

[/code]