Reference – WordPress Knowledgebase Plugin

外掛說明

Reference – WordPress Knowledgebase Plugin

Reference is a WordPress Knowledgebase plugin that helps you manage your Knowledgebase articles quickly. Create and organize each of your articles base on their topics.

The ‘Breadcrumb’ feature gives your users a secondary navigation menu that helps your readers scan through your documentation and to view more content at a faster rate.

This plugin uses the ‘WordPress Menu System’ in giving you convenience in creating ‘Table of Contents’ for your knowledgebase.

The ‘Comment Feedback’ feature allows you to gather votes from your users and gives you the information about the usefulness of your knowledgebase article – readers can ‘downvote’ and ‘upvote’ each item (checked via IP).

There are also useful feature such as allowing you to display your ‘Topics’ in three columns, two columns or one column layout.

Templating

Reference adheres to the WordPress standard Templating System to make it accessible to any developers make this plugin compatible with their themes. To get started, copy the sample template files of the plugin inside ‘reference/templates/twentyseventeen’ and paste each file inside your theme.

• archive-dsc-knowledgebase.php – The post type archive template file
• knowledgebase-none.php – The 404 or no content found template file
• knowledgebase-search.php – The search template file
• single-dsc-knowledgebase.php – The template for single knowledgebase
• taxonomy-knb-categories.php – The categories template file

After you have copied the said files in the list above, you can open each file with your favorite code editor and start modifying the markup to make sure your theme is compatible.

You may also use the existing template tags to make your work faster and easier.

Features

• Breadcrumbs
• Drag and Drop Menu using the WordPress Menu System
• Table of Contents
• Sticky Table of Contents
• Syntax Highlighting Shortcode
• Ten Syntax Highlighting Styles
• Comment Feedback
• Column Display
• Reference Shortcode

Contribute

If you’re a developer and looking to contribute to this project. Please visit the GitHub page and kindly send a pull request. Your contribution is greatly appreciated 🙂