Very Simple Knowledge Base

Descripción

About

This is a lightweight plugin to create a knowledge base.

Add shortcode [knowledgebase] on a page or use the widget to display your categories and posts.

You can personalize your knowledge base by adding attributes to the shortcode or the widget.

This plugin can also be used to create a FAQ or wiki.

You can also list categories and posts from a custom post type (such as «product» or «event»).

How to use

After installation create a page and add shortcode [knowledgebase] to display your categories and posts.

Or go to Appearance > Widgets and use the widget to display your categories and posts.

Default settings categories:

  • 4 columns when using shortode
  • 1 column when using widget
  • Order by name
  • Ascending order (A-Z)
  • Empty categories are hidden
  • Parent and subcategories are listed separately

Default settings posts:

  • Order by date
  • Descending order (new to old)
  • All posts are displayed

Shortcode attributes

You can add attributes to the shortcode mentioned above.

  • Change number of columns: columns="3"
  • Add custom CSS class to knowledge base: class="your-class-here"
  • Include certain categories: include="1,3,5"
  • Exclude certain categories: exclude="8,10,12"
  • Display empty categories too: hide_empty="0"
  • Display category description: description="true"
  • Change number of posts per category: posts_per_page="5"
  • Display posts in ascending order: order="ASC"
  • Display posts by title: orderby="title"
  • Display posts in random order: orderby="rand"
  • Display number of posts (post count) count="true"
  • Display post meta (date and author): meta="true"
  • Display View All link: all_link="true"
  • Change label of View All link: all_link_label="your label here"
  • Change label of post without title: no_title_label="your label here"

About the columns attribute: you can choose between 1-4 columns. In mobile screens 2 columns (except the 1 column knowledge base).

You can disable the CSS of the individual columns with columns="0". This can be useful when using your own styling.

Examples:

  • One attribute: [knowledgebase posts_per_page="5"]
  • Multiple attributes: [knowledgebase include="1,3,5" hide_empty="0" meta="true"]

Widget attributes

The widget supports the same attributes. Don’t add the main shortcode tag or the brackets.

Examples:

  • One attribute: posts_per_page="5"
  • Multiple attributes: include="1,3,5" hide_empty="0" meta="true"

Post tags

Besides listing posts by category you can also list posts by tag: taxonomy="post_tag"

Custom post types

You can also list categories and posts from a custom post type (such as «product» or «event»).

To list these categories and posts you should add 2 shortcode attributes: «taxonomy» and «post_type»

You can for example list WooCommerce products:

  • List products: taxonomy="product_cat" post_type="product"
  • List products with product category image: taxonomy="product_cat" post_type="product" woo_image="true"
  • List products by tag instead of category: taxonomy="product_tag" post_type="product"

Question?

Please take a look at the FAQ section.

Traduccion

Not included but plugin supports WordPress language packs.

More translations are very welcome!

Créditos

Without the WordPress codex and help from the WordPress community I was not able to develop this plugin, so: thank you!

Enjoy!

Capturas

  • Very Simple Knowledge Base page (GeneratePress theme).
  • Very Simple Knowledge Base page (dashboard).
  • Very Simple Knowledge Base WooCommerce products (GeneratePress theme).
  • Very Simple Knowledge Base widget (dashboard).

Instalación

Please check Description section for installation info.

Preguntas frecuentes

Where is the settingspage?

Plugin has no settingspage, use the shortcode with attributes or the widget with attributes to make it work.

Does this plugin have its own knowledge base post type?

No, it’s build to create a knowledge base by using the native categories and posts.

You can also list categories and posts from a custom post type (such as «product» or «event»).

How can I change the layout or colors?

Besides the number of columns, the layout or colors of the knowledge base can only be changed by using custom CSS.

You can disable the CSS of the individual columns with columns="0". CSS class «vskb-custom» is added to the knowledge base, so you can use that for your custom styling.

Where to find the category ID?

Every category URL contains an unique ID. You will find this ID when hovering the category title in your dashboard or when editing the category.

It’s the number that comes after: tag_ID=

Where to find the tag ID?

Every tag URL contains an unique ID. You will find this ID when hovering the tag title in your dashboard or when editing the tag.

It’s the number that comes after: tag_ID=

Is it possible to list a subcategory underneath its parent?

No, this is not possible. Parent and subcategories are listed separately.

Is a post without a title also displayed?

Yes, it will be displayed in the frontend of your website with a default label. You can change this label by using an attribute.

Does this plugin have its own block?

No, plugin doesn’t have its own block in the editor and there are no plans to add this anytime soon.

No Semantic versioning?

Version number doesn’t give you info about the type of update (major, minor, patch). You should check changelog for that.

How can I make a donation?

You like my plugin and you’re willing to make a donation? Thanks, I really appreciate that! There’s a PayPal donate link at my website.

Other question or comment?

Please open a topic in plugin forum.

Reseñas

23 de junio de 2019
This is a lightweight plugin but it has a power feature. It is easy to configure and display posts. If you have a good understanding of css, it will be much better. In addition to that, the creator is very helpful and supportive.
24 de septiembre de 2018
A quick and simple way to get up and running with a kb. Perfect for understanding what you need without feature clutter of "advanced" plugins. Good support also.
29 de marzo de 2018
Super straight forward and easy to use knowledge base plugin for posts. There isn't a search bar though. Otherwise this is very nice.
Leer todas las 16 reseñas

Colaboradores y desarrolladores

«Very Simple Knowledge Base» es un software de código abierto. Las siguientes personas han colaborado con este plugin.

Colaboradores

«Very Simple Knowledge Base» ha sido traducido a 6 idiomas locales. Gracias a los traductores por sus contribuciones.

Traduce «Very Simple Knowledge Base» a tu idioma.

¿Interesado en el desarrollo?

Revisa el código , echa un vistazo al repositorio SVN o suscríbete al registro de desarrollo por RSS.

Registro de cambios

Version 6.2

  • Fix: custom CSS class

Version 6.1

  • Better validating, sanitizing and escaping

Version 6.0

  • New: attribute to disable the CSS of the columns
  • This can be useful when using your own styling
  • Re-added attribute for adding custom CSS class to the knowledge base

Version 5.9

  • Minor changes in code

Version 5.8

  • Minor changes in code

Version 5.7

  • New shortcode structure
  • Plugin now only has 1 main shortcode tag: [knowledgebase]
  • With attribute «columns» you can set the number of columns (1-4)
  • Example: [knowledgebase columns=»2″]
  • Notification in frontend when shortcode is deprecated
  • You also may need to set columns in your widget again
  • Added CSS class to the knowledge base (based on number of columns)
  • Removed attribute for adding custom CSS class to the knowledge base
  • Minor changes in code
  • Updated stylesheet

Version 5.6

  • Minor changes in code

Version 5.5

  • Fix: alignment in Twenty Twenty and Twenty Twenty-One theme
  • Updated stylesheet

Version 5.4

  • Changed structure of the knowledge base
  • Previous structure was not valid HTML
  • Updated stylesheet

Version 5.3

  • Removed file vskb-list
  • Added file vskb-template instead
  • Minor changes in code

For all versions please check file changelog.