Git Product home page Git Product logo

knowledgebase's Introduction

WebberZone Knowledge Base

Knowledge Base

WordPress Plugin Version License WordPress Tested Required PHP Active installs

Requires: 5.6

Tested up to: 6.2

License: GPL-2.0+

Plugin page: Knowledge Base | WordPress.org Plugin page

Fastest way to create a highly-flexible multi-product knowledge base on you WordPress site.

Description

Knowledge Base 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.

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
  • 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. You can create an issue on the Github page or, better yet, fork the plugin, add a new feature and send me a pull request.

Screenshots

Knowledge Base Menu in the WordPress Admin Knowledge Base Menu in the WordPress Admin

For more screenshots visit the WordPress plugin page

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 is a working example of a multi-product knowledge base.

Frequently Asked Questions

Check out the FAQ on the plugin page and the Knowledge Base.

If your question isn't listed there, please create a new post at the WordPress.org support forum. It is the fastest way to get support as I monitor the forums regularly. I also provide premium paid support via email.

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 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. Articles archive: archive-wz_knowledgebase.php
  2. Category archive: taxonomy-wzkb_category.php
  3. 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 which allows you to easily drag and drop posts, sections or tags to display them in a custom order.

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. In addition to stable releases, latest beta versions are made available under releases.

knowledgebase's People

Contributors

ajaydsouza avatar fredericguilbault avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

knowledgebase's Issues

Live search

Implement live search from the search box to directly find articles

Add language files in Dutch

Hello,

I'm new here on GitHub. But I've made a .po and a .mo file with the translations for this plugin in Dutch. Is it possible to implement them in this plugin? I'll add them in a ZIP-file for you.
wzkb-nl_NL.zip

When I've uploaded these files in the language file on the server, I don't see any changes. Did I miss out on an action?

Hope to here from you soon.

Kind Regards,

Cynthia

Widget support

Add widgets to display:

  • Knowledgebase categories / sections

  • Articles in a section

  • Breadcrumbs

Breadcrumbs

Function to display breadcrumbs. Template to include this automatically on category and page views.

Recent articles

New feature to track viewed articles for current user via cookies and then display this as they browse through the knowledge base

Problem using page slug with WooCommerce breadcrumbs

I set the page slug to something like knowledge-base and I use a custom page with this slug. Then on that page I use the kb blocks to layout the page the way I want. When I go to that page it all looks great, I click an article and it takes me to that article's page, so far so good. When I click the breadcrumb to take me back to the knowledge base page it takes me to a page that's using the plugin's template instead of the custom page I set up.

Is there a way to tell the plugin to use my page and not use its own template?

New taxonomy for Product

The current method of multi-products is not intuitive as it requires a second-level view of the categories/sections taxonomy.

Add a new taxonomy or post meta to create new products. Each product can have its own set of sections.

Shortcode: Search form

Create a new parameter to display the search form when using [knowledgebase]

Potentially: [knowledgebase searchform="1"]

Related KB-Articles for Blog Posts

Hi,
i would like to have something like "Related Knowledgebase Articles" under my Blog Postings, if i use the same Tags on Blogpost and Article.

Message based shortcodes

Add several shortcodes that allow a user to indicate specific messages, e.g. info, warning, tip, success, etc.

No. of articles

Add number of articles in the title section. Wrapped in tags so that it can be styled by CSS

Delete data on uninstall

Add an option to delete all settings and data at uninstall.

Should be 2 checkboxes:

  • Option to delete the settings - True by default
  • Option to delete all data including custom posts, categories and tags - False by default

Top Level Knowledgebase

By default the Knowledgebase is designed to start adding span_1_of_2 from 2nd level categories onwards.

Add a new option for this to take place at the top level itself as most users will directly dive into the categories /sections rather than put it one level down.

Posts template

Knowledge base articles should display in their own template if one is not added in the theme.

Comments for KB-Articles

I want to enable Comments for KBArticles to interact with my Commnity.
This is useful to Improve my KB =)

Show sidebar

Option to show sidebar in the default templates

My knowledgebase broken css

why my knowledgebase appear in vertical view ?

category1
category1
.category1
category1

not

category1 category1 category1 category1
category1 category1 category1 category1

any suggestions ?

Custom post types in Feed

Add option to show the knowledgebase in the main WordPress blog feed:

<?php // ADD CUSTOM POST TYPES TO RSS FEED //
function wzkb_in_feed( $args ) {
  if ( isset( $args['feed'] ) && !isset( $args['post_type'] ) )
    $args['post_type'] = array('post', 'gallery', 'product');
  return $args;
}
add_filter( 'request', 'wzkb_in_feed' );

New option: Title

Add a new setting to enter the title of the knowledgebase which will be displayed on archived pages instead of the archive title

Template subfolder

I'm overriding the default template but I'd rather not included the new template files in the root of my child theme. Could you add the possibility to include them in a knowledge base sub-folder?

Thanks!

CSS error in the column spacing

The third and subsequent items in sub sections are indented when they shouldn't be in a 2 column layout. I have corrected this with some custom css

.col:nth-child(2n+1) {margin-left: 0 !important;}

This is the result before and after adding the custom CSS
screen shot 2017-02-23 at 15 44 20-s
screen shot 2017-02-23 at 15 43 26-s

Set number of columns - Enhancement

Would it be possible to enhance the plugin with the option for the user to set the number of columns to display? On a site of say 1200px width there is sufficient space for about 4 categories if there is no sidebar display.

Caching

Implement caching for the knowledgebase

  • Caching at master level
  • Caching at category level, if possible

Read more

New option to limit the number of articles in a category post which a Read more link will be displayed.

Width of search box too big.

You currently have the width of the search box set in your CSS as 100% and you have then added a margin to this div. As a result the search box goes outside the page width on the right side and causes a horizontal scroll bar on sites. Change the width to ~95% so the definition should be
.wzkb-search-form { border: 1px solid #ddd; font-size: 1.3em; margin: 20px 0; padding-left: 10px; padding-right: 12px; position: relative; width: 95%; }

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.