Professional Documents
Culture Documents
Heroic Knowledge Base Plugin
Version 1.4
Thank you for choosing the Hero Themes Knowledge Base plugin,
this plugin will add a knowledge base to your WordPress powered
site and features:
● Simple and powerful Knowledge Base
● Live search functionality
● Custom knowledge base post types
● Custom categories and tags
● Add attachments
● Vote articles (with Heroic Voting plugin)
Hero Themes are the creators of the #1 premium Knowledge Base theme for WordPress. This
guide documents how to set up and configure the Knowledge Base plugin.
1 of 17
Installation
To install Heroic Knowledge Base you will require a selfhosted WordPress version 3.5 or higher
installation. A supporting Hero Theme is not required but offers additional functionality and
enhanced experience.
You can install the plugin in a number of ways:
● From Zip File : In the WordPress admin panel navigate to Plugins > Add New , select the
‘Upload’ and browse to the zipped plugin file, and hit install now.
● FTP Upload : Using your FTP program upload the unzipped plugin folder into the
/wpcontent/plugins/ folder of your WordPress installation.
Once the plugin has been installed, you need to activate it. Go to Plugins > Installed Plugins
and activate the Heroic Knowledge Base.
Welcome Screen
Upon plugin activation, you will automatically be sent to the Heroic Knowledge Base welcome
page.
The top left panel outlines the
basic areas of the knowledge base. The knowledge base archive
is made up of a number of articles which can be categorized and tagged like other WordPress
posts. To make the most of the knowledge base it may be important to consider the structure of
the articles ahead of time, to ensure coherence and discoverability of content.
The sample content section allows you to install demo content , including a numbers of articles,
categories and tags, which can be used to test the knowledge base layout and gives a great
example of how the knowledge base can be structured and tagged. Note there is no demo
uninstall button, but you can delete and edit all the articles, categories and tags after the sample
has been installed. To install the sample content, simply click Set Up Sample Knowlege Base, it
only takes a few moments and creates and configures a sample knowledge base automatically.
To get the most of of your knowledge base, be sure to sign up to get access to exclusive
content and update news. Simply enter your email address (which may be prepopulated) click
the subscribe button. We never share your personal details without your permission and you
can unsubscribe at any time.
2 of 17
In order to receive automatic updates and premium support, be sure to enter you product license
key (found in your purchase email) on the
License and Updates tab from the setting page. This
will help keep your Knowledge Base running smoothly and access support quickly should it be
needed. The support section also has a quick link to this documentation.
This page can be visited again at any time from the plugins page and selecting Getting Started
3 of 17
Creating and Using Knowledge Base Articles
There will now be a new Knowledge Base menu in the WordPress admin panel.
From here you can manage existing articles, create new articles and control the Knowledge
Base categories and tags. Articles are the components of your knowledge base. These work a
lot like any other posts, but have there own archive, categories and tags.
Select
Add New Article to create a new Heroic Knowledge Base Article
From this page, you can control everything about your article:
● Title – The title of the article
● Content The body content of the article
● Options Add attachments and allow voting (if voting plugin also activated)
● Format The format of article (may be used by theme)
● Categories Custom knowledge base categories the article will be classified under.
● Tags Custom knowledge base tags to associate with the article.
4 of 17
Article Options
Attachments can be added to an article here. Select Add or Upload File to select upto four
attachments to add to the article.
The article
View Count can be set in the options.
For installations with the optional voting module, the following options are in the voting options
box.
Disable voting on the individual article.
To reset votes , check the Reset Voting box and update the article, all votes will be removed
Usefulness is determined by the votes, manually setting the usefulness in this box can cause
inconsistencies to develop in the usefulness calculation.
5 of 17
Live Search Articles
The knowledge base features live search functionality, users can search the knowledge base in
articles, titles, categories and tags. The options for the live search can be controlled from
Knowledge Base > Settings > Search Options .
6 of 17
Settings
The settings menu from
Knowledge Base > Settings allows you to control various options for the
whole Knowledge Base. These are divided into three sections General,
Live Search and
Slugs
, which can be seen on the left of the settings panel.
General Settings
The general settings control a numbers of options related to how the Knowledge Base is
displayed, search as sort order and the number of articles to display in categories and tags.
7 of 17
Archive Options
The archive options page controls the settings for the archive view of the knowledge base
archive, such as what detail to show for categories and articles
8 of 17
Article Options
The article options page controls the settings for the individual knowledge base articles, such as
meta and comments options.
9 of 17
Search Options
The search options page controls settings for options related to the Knowledge Base search
functionality. You can set which post types to display and what meta to show.
10 of 17
Slugs Settings
From this screen you can set the slugs for the Knowledge Base
Important note on slugs: The knowledge base allows you to define custom slugs for Heroic
Knowledge Base articles, categories and tags. These can be controlled from Knowledge Base >
Settings > Slugs. On updating the slugs, you may need to ‘flush’ your permalinks by visiting
Settings > Permalinks, this forces WordPress to update the relevant slugs.
11 of 17
Voting Options
With the optional voting module, the voting options page allows you to control various voting
options
12 of 17
Knowledge Base Widgets
Heroic Knowledge Base comes with three widgets for displaying information from the Knowledge
Base:
● Articles Knowledge Base Articles
● Authors Knowledge Base Authors
● Categories Knowledge Base Categories
Widgets can be activated from Appearance > Widgets and dragging to an active widget area,
this allows you to display key information from the Knowledge Base across your site.
The widgets available in Heroic Knowledge Base
13 of 17
Additional Tips
Linking to the Knowledge Base
You can link to any of the knowledge base articles as with any other post. To add the knowledge
base to a menu, goto Appearance > Menus and add the ‘Heroic Knowledge Base Archive’ to any
of the menus.
Using the Knowledge Base as the homepage
To use the Knowledge Base as the homepage, set Front page to Knowledge Base Archive (a
dummy page created by the Knowledge Base plugin) in
Settings > Reading
.
Voting
With the optional Heroic Voting module installed and activated, visitors to the knowledge base
can vote on articles. Top articles and contributors are assigned badges, depending on theme
support.
14 of 17
Heroic Knowledge Base Categories
With the Heroic Knowledge Base, you can create, edit and control custom categories for your
knowledge base articles.
Knowledge base categories can be created in two ways:
1. From Knowledge Base > Article Categories .
2. From an article add/edit page, under the Knowledge Base Category
In certain themes, category images and colours can be controlled from the Edit Knowledge Base
Category page. These options will appear if available.
15 of 17
Controlling the Article Category Order
The knowledge base category order can be controlled from the Knowledge Base > Article
Category Ordering page. Drag and drop categories to reorder and change the order they are
displayed on your site.
The parent category and nesting options can be controlled from the edit category page.
16 of 17
F.A.Q. and Support
For customers with a valid license, you can get premium support at
http://herothemes.com/support/ .
17 of 17