Skip to content

Commit

Permalink
Merge pull request #59 from WebberZone/oops
Browse files Browse the repository at this point in the history
Implementation of classes
  • Loading branch information
ajaydsouza authored Dec 13, 2024
2 parents c5aa912 + a772f2f commit c5a2464
Show file tree
Hide file tree
Showing 94 changed files with 6,731 additions and 4,484 deletions.
44 changes: 22 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,32 +16,32 @@ __License:__ [GPL-2.0+](http://www.gnu.org/licenses/gpl-2.0.html)

__Plugin page:__ [Knowledge Base](https://webberzone.com/plugins/knowledgebase/) | [WordPress.org Plugin page](https://wordpress.org/plugins/knowledgebase/)

Fastest way to create a highly-flexible multi-product knowledge base on you WordPress site.
Effortlessly build a comprehensive knowledge base for unlimited products on your WordPress site and elevate your customer support experience.

## 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.
[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 site.

This is perfect if you have single or multiple products and want a single knowledge base with little effort.
You can use it to create a single or multi-product 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.
The plugin was born after I tried several free plugins and themes that didn'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/).
You can view a [live demo of my 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*
* __Sections__: A custom taxonomy ( `kbcategory` ) used to create the knowledge base. You will need *at least one category* to display the knowledge base. Add these categories 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
* Inbuilt styles that display the Knowledge Base 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 automatically at `/knowledgebase/` upon activation. You can change this on the Settings page
* Shortcode: `[knowledgebase]` will allow you to display the knowledge base on any page you choose. 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
* Breadcrumbs: Default templates include breadcrumbs. Alternatively, use the function 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

Expand All @@ -54,15 +54,15 @@ If you have an idea, I'd love to hear it. WebberZone Knowledge Base is also avai
![Knowledge Base Menu in the WordPress Admin](https://raw.githubusercontent.com/WebberZone/knowledgebase/master/wporg-assets/screenshot-1.png)
*Knowledge Base Menu in the WordPress Admin*

For more screenshots visit the [WordPress plugin page](http://wordpress.org/plugins/knowledgebase/screenshots/)
For more screenshots, visit the [WordPress plugin page](http://wordpress.org/plugins/knowledgebase/screenshots/)

## 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
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
Expand All @@ -77,10 +77,10 @@ For more screenshots visit the [WordPress plugin page](http://wordpress.org/plug
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:
The plugin supports unlimited levels of category hierarchy. To build a multi-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
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.
Expand All @@ -89,19 +89,19 @@ The plugin supports unlimited levels of category hierarchy. To build a multiple

Check out the [FAQ on the plugin page](http://wordpress.org/plugins/knowledgebase/faq/) and the [Knowledge Base](https://webberzone.com/support/section/knowledgebase/).

If your question isn't listed there, 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/).
If your question is not listed below, 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.
This is usually due to outdated permalinks. To flush the existing permalink rules, 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.
For details on all the shortcodes included in the plugin, refer to [this Knowledge Base article](https://webberzone.com/support/knowledgebase/knowledge-base-shortcodes/).

### Using your own templates for archives and search
### Using your 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`
WebberZone Knowledge Base comes built with custom templates to display archives of the articles, category archives, and search results. You can easily override any of these templates by creating your template in your theme's folder or in `wp-content/knowledgebase/templates`

1. Article view: single-wz_knowledgebase.php or single-wz_knowledgebase.html
2. Articles archive: archive-wz_knowledgebase.php or archive-wz_knowledgebase.html
Expand All @@ -118,4 +118,4 @@ You can report security bugs through the Patchstack Vulnerability Disclosure Pro

## About this repository

This GitHub repository always holds the latest development version of the plugin. If you're looking for an official WordPress release, you can find this on the [WordPress.org repository](http://wordpress.org/plugins/knowledgebase). In addition to stable releases, latest beta versions are made available under [releases](https://github.com/WebberZone/knowledgebase/releases).
This GitHub repository always holds the latest development version of the plugin. If you're looking for an official WordPress release, you can find this on the [WordPress.org repository](http://wordpress.org/plugins/knowledgebase). In addition to stable releases, the latest beta versions are made available under [releases](https://github.com/WebberZone/knowledgebase/releases).
17 changes: 9 additions & 8 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"name": "webberzone/knowledgebase",
"description": "Fastest way to create a highly-flexible multi-product knowledge base.",
"version": "2.3.0",
"type": "wordpress-plugin",
"keywords": [
"knowledge base",
Expand All @@ -21,14 +22,14 @@
"php": ">=7.4"
},
"require-dev": {
"szepeviktor/phpstan-wordpress": "^1.3",
"phpstan/extension-installer": "^1.3",
"phpstan/phpstan": "^1.10",
"php-stubs/wordpress-stubs": "^6.5",
"wp-coding-standards/wpcs": "^3.0",
"dealerdirect/phpcodesniffer-composer-installer": "^0.7",
"phpcompatibility/phpcompatibility-wp": "^2.1",
"yoast/phpunit-polyfills": "^1.0",
"szepeviktor/phpstan-wordpress": "^1",
"phpstan/extension-installer": "^1",
"phpstan/phpstan": "^1",
"php-stubs/wordpress-stubs": "^6",
"wp-coding-standards/wpcs": "^3",
"dealerdirect/phpcodesniffer-composer-installer": "^1",
"phpcompatibility/phpcompatibility-wp": "^2",
"yoast/phpunit-polyfills": "^3",
"phpunit/phpunit": "^5.7.21 || ^6.5 || ^7.5"
},
"config": {
Expand Down
132 changes: 0 additions & 132 deletions includes/activate-deactivate.php

This file was deleted.

Loading

0 comments on commit c5a2464

Please sign in to comment.