-
Notifications
You must be signed in to change notification settings - Fork 6
/
readme.txt
160 lines (104 loc) · 7.76 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
=== Knowledge Base ===
Contributors: Ajay, webberzone
Donate link: https://ajaydsouza.com/donate/
Tags: knowledge base, knowledgebase, FAQ, frequently asked questions, support, documentation
Requires at least: 5.6
Tested up to: 6.2
Requires PHP: 7.1
Stable tag: 2.2.0
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Fastest way to create a highly-flexible multi-product knowledge base on you WordPress site.
== Description ==
[Knowledge Base](https://webberzone.com/plugins/knowledgebase/) is an easy to use WordPress plugin that allows you to create a knowledge base / FAQ section on your WordPress blog.
This is perfect if you have single or multiple products and want a single knowledge base with little effort.
The plugin was born after I tried several free plugins and themes out there and that couldn't fit my purpose. It's designed to be very easy to install and use out of the box.
You can view a [live demo of my own knowledge base](https://webberzone.com/support/knowledgebase/).
= Terminology =
* **Articles**: A custom post type `wz_knowledgebase` is used to store all the knowledge base articles
* **Sections**: A custom taxonomy ( `kbcategory` ) used to create the knowledge base. You will need *at least one category* in order to display the knowledge base. These categories can be added under *Knowledge Base > Sections*
* **Tags**: Additionally you can use tags ( `kbtags` ) can also be used for each knowledge base article.
= Main features =
* Supports unlimited knowledge bases using different sections with unlimited nested levels
* Inbuilt styles that display the knowledge beautifully and are fully responsive - Uses the [Responsive Grid System](http://www.responsivegridsystem.com/)
* Customizable permalinks: Archives are enabled so your knowledge base can be viewed at `/knowledgebase/` automatically on activation. You can change this in the Settings page
* Shortcode: `[knowledgebase]` will allow you to display the knowledge base on any page of your choosing. For other shortcodes, check the FAQ
* Gutenberg block: You can display the knowledge base using a block. Find it by typing `kb` or `knowledge base` when adding a new block
* Breadcrumbs: Default templates include breadcrumbs. Alternatively, use functions or shortcode to display this where you want
* Widgets: WZKB Articles, WZKB Sections and WZKB Breadcrumbs
* Inbuilt cache to speed up the display of your knowledge base articles
= Contribute =
If you have an idea, I'd love to hear it. WebberZone Knowledge Base is also available on [Github](https://github.com/WebberZone/knowledgebase). You can [create an issue on the Github page](https://github.com/WebberZone/knowledgebase/issues) or, better yet, fork the plugin, add a new feature and send me a pull request.
== Installation ==
= WordPress install (The easy way) =
1. Navigate to “Plugins” within your WordPress Admin Area
2. Click “Add new” and in the search box enter “Knowledgebase” or "Knowledge Base"
3. Find the plugin in the list (usually the first result) and click “Install Now”
4. Activate or Network activate the Plugin in WP-Admin under the Plugins screen
= Manual install =
1. Download the plugin
2. Extract the contents of knowledgebase.zip to wp-content/plugins/ folder. You should get a folder called knowledgebase.
3. Activate or Network activate the Plugin in WP-Admin under the Plugins screen
= Usage =
1. Visit `Knowledge Base » Sections` to add new categories to the knowledge base
2. Visit `Knowledge Base » Add New` to add new Articles to the knowledge base. You can select a section from there while adding
3. Optionally, create a new page or edit an existing one and add the shortcode `[knowledgebase]` or use the block to set up this page to display the knowledgebase
The plugin supports unlimited levels of category hierarchy. To build a multiple product knowledge base:
1. Set the *First section level* under the Output tab to 2
2. Create a set of top level sections for each product
3. Create sub-sections for each of the products
[This live demo](https://webberzone.com/support/knowledgebase/) is a working example of a multi-product knowledge base.
== Frequently Asked Questions ==
If your answer to your question isn't listed here or the [Knowledge Base](https://webberzone.com/support/section/knowledgebase/), please create a new post at the [WordPress.org support forum](http://wordpress.org/support/plugin/knowledgebase). It is the fastest way to get support as I monitor the forums regularly. I also provide [premium *paid* support via email](https://webberzone.com/support/).
= 404 errors on the knowledge base =
This is usually because of outdated permalinks. To flush the existing permalinks rules simply visit Settings » Permalinks in your WordPress admin area.
= Shortcodes =
Refer to [this Knowledge Base article](https://webberzone.com/support/knowledgebase/knowledge-base-shortcodes/) to details of all the shortcodes included in the plugin.
= Using your own templates for archives and search =
WebberZone Knowledge Base comes inbuilt with a set of custom templates to display archives of the articles, category archives as well as search results. You can easily override any of these templates by creating your own template in your theme's folder or in `wp-content/knowledgebase/templates`
1. Article view: single-wz_knowledgebase.php
2. Articles archive: archive-wz_knowledgebase.php
3. Category archive: taxonomy-wzkb_category.php
4. Search results: search-wz_knowledgebase.php
= How do I sort the posts or sections? =
The plugin doesn't have an inbuilt feature to sort posts or sections. You will need an external plugin like [Intuitive Custom Post Order](https://wordpress.org/plugins/intuitive-custom-post-order/) which allows you to easily drag and drop posts, sections or tags to display them in a custom order.
== Screenshots ==
1. Knowledge Base Menu in the WordPress Admin
2. Knowledge Base Viewer Facing with Default styles
3. Knowledge Base alerts
4. Settings » General
5. Settings » Output
6. Settings » Styles
7. Knowledge Base widgets
== Upgrade Notice ==
= 2.2.0 =
* Multiple Enhancements. Refer to the changelog
== Changelog ==
= 2.2.0 =
Release post: [https://webberzone.com/blog/knowledge-base-v2-2-0/](https://webberzone.com/blog/knowledge-base-v2-2-0/)
* Enhancements:
* The plugin will now look for templates within `wp-content/knowledgebase/templates` folder if it is not found within the existing theme before using the plugin's included templates
* Alerts block now shows a preview and the Default style is inserted correctly
* Upgrade settings handling to use the WebberZone Settings_API class
* Knowledge Base block is wrapped in the `<Disabled>` component which prevent any accidental clicking when you're using it in the block editor (Gutenberg)
= 2.1.2 =
* Security fix in block
= 2.1.1 =
Release post: [https://webberzone.com/blog/knowledge-base-v2-1-0/](https://webberzone.com/blog/knowledge-base-v2-1-0/)
* Enhancements:
* New options to set number of articles and to show excerpt in the widget
* Bug fixes:
* Update activation on multisite when a new blog is added
* PHP errors when using the widget
= 2.1.0 =
* Features:
* New related articles module. Enable/disable in the settings page
* New Gutenberg block for alerts. Original knowledge base block has been upgraded to use block.json
* Enhancements:
* `wzkb_knowledge` function takes additional parameters that override global settings if passed
* Additional settings added for Knowledge Base block
* Bug fixes:
* Fixed Custom CSS loaded incorrectly with a 0 on install/reset
* Dashicons were not properly loaded on frontend
= Earlier versions =
For the changelog of earlier versions, please refer to the separate changelog.txt file or the [Github releases page](https://github.com/WebberZone/knowledgebase/releases)