Knowledge Building

By Tarmo Toikkanen

★ 5.0/5 (1 ratings)10+ active installationsVersion 0.8.1

Use comment threads to facilitate meaningful knowledge building discussions. Comes with several knowledge type sets (eg. progressive inquiry, six hat …

Description

Knowledge Building is a process of collaboratively building new understanding and knowledge through meaningful discussion. This plugin allows knowledge building processes to happen on WordPress comments. There are several different knowledge typesets to choose from, and they can be mapped to individual post categories, so other posts will continue to use their normal commenting functionality, while some categories will be equipped with knowledge building tools.

This plugin is primarily meant for use in educational settings, but can of course be used for any meaningful purpose.

Each discussion can also be explored as an interactive map, where notes are shown as connected nodes that can be grouped by discussion thread, knowledge type, author or time.

The plugin uses the jQuery and jQuery UI libraries that come with WordPress. The map view uses the Raphaël vector graphics library (MIT license) and the Junge font by Cyreal (SIL Open Font License), both included in the plugin. Apart from avatars, which follow your site’s avatar settings, the plugin doesn’t load anything from external servers.

For more regular updates see GitHub.

Installation

This section describes how to install the plugin and get it working.

  1. Install the plugin from Plugins, Add New, or unzip it into the /wp-content/plugins/ directory.
  2. Activate the plugin through the ‘Plugins’ menu in WordPress.
  3. Go to Settings, Knowledge Building and select which post Categories should have Knowledge Building enabled.

The plugin works with both block themes (such as Twenty Twenty-Five) and classic themes. In a block theme, the Comments block on posts that use a knowledge type set is replaced by the knowledge building discussion; other posts keep the theme’s normal comments.

Please note that since this plugin relies heavily on the commenting feature, not all classic themes will work nicely. Specifically, classic themes work best when they use the WordPress built-in comment Walker. You can detect this by checking whether or not your comments.php template has a call to ‘wp_list_comments’ or not. If it does not, then it has its own custom way of showing comments, which this plugin cannot easily work with. You can either select another theme which uses WordPress Walker, or just try and replace the code in comments.php that displays comments with a call to knbu_list_comments(); and cross your fingers. 🙂

FAQ

How should I set up my blog to best leverage KB?

I’d suggest creating categories such as “Progressive Inquiry”, “Six Hat Thinking” etc. to match the knowledge type sets that you want to use. If your blog will be used in several courses, then I suggest you also create a category for each course. Another good category would be “News”. You can then create posts by combining several categories:

  • Course1 + News: news about course 1
  • Course1 + Progressive Inquiry: a knowledge building context for course 1, using progressive inquiry as the knowledge type set
  • Course2 + Six Hat Thinking: a knowledge building context for course 2, using six hat thinking

This way it’s easy for students to follow just the course they’re interested in, and also to spot knowledge building contexts.

After you’ve set up the categories, go to Settings, Knowledge Building, and assign categories to available knowledge type sets. Note that if a post has several categories that are assigned to KB sets, things will become unpredictable.

In Settings, Discussion it’s probably a good idea to enable threaded (nested) comments, so people can respond to individual comments, and not only at the end of the comments list. Also you might want to disable breaking of comments into pages (as sorting of comments will only sort comments on that one page).

For discussion moderation and other visibility settings, do what feels right. You can close off your entire blog from public view and require students to log in (maybe use an LDAP plugin to get login information from your school’s systems), or keep the blog open – it’s up to you. If you do know that only your students will have access to the commenting feature, you might want to disable the “automatically moderate if comment contains more than N links” setting.

What is removed when I delete the plugin?

Deleting the plugin removes its settings. The knowledge types, titles and map positions saved with comments are kept, so the discussions are intact if you install the plugin again.

Can the plugin be translated?

Yes. The plugin’s own texts can be translated at translate.wordpress.org. The names and descriptions of knowledge types come from the type set XML files; to translate those, copy a type set file and edit it (see below).

Where can I get more Knowledge Typesets?

Go to http://fle3.uiah.fi/download.html to find typesets exported from Fle3. Basically you just need to download the zip file, open it, and take the ‘fledom.xml’ file, rename it something meaningful (like the name of the zip file you downloaded) while retaining the xml extension, and place the file into the kbsets folder of this plugin.

How can I create new Knowledge Typesets?

Either copy an existing typeset’s XML file to a new name, and edit it to your liking, or use the online editor of Fle3 to create a new set, and export it into an XML file (see previous question).

Screenshots

Changelog

=0.8.1=
* The plugin can now be translated.
* Notes on the map are numbered reliably: notes posted at the same time no
longer get the same number, and numbering starts after the post itself
(#1). Older notes numbered 0 or 1 get a new number the first time they
are shown.
* Sorting notes by date now works with every date format, and sorting by
person works with names that contain quotes or brackets.
* Clicking a note’s number in the comment list opens it on the map.
* The map view loads the theme’s footer scripts, uses the site’s language
and character set, hides the admin toolbar, and zooms with touchpads too.
* Map replies that fail because of a network error can be sent again
without reloading the page.
* The map font is now included in the plugin instead of being loaded from
Google Fonts.
* Updated the Raphaël library to 2.3.0 and replaced the old mousewheel
plugin with built-in browser events.
* Styles and scripts are only loaded on posts that use a knowledge type set.
* Avatars follow the site’s default avatar setting.
* Fixed form labels, duplicate element IDs and the reply form reset on the
map.
* Tidied the settings page and added an uninstall routine that removes the
plugin’s settings.

=0.8.0=
* Added support for block themes. On posts that use a knowledge type set,
the theme’s Comments block shows the knowledge building discussion and
reply form. Tested with Twenty Twenty-Three, Twenty Twenty-Four and
Twenty Twenty-Five.
* Fixed knowledge type sets not being found when WordPress is run from the
command line (WP-CLI).

=0.7.3=
* Security: fixed a stored cross-site scripting (XSS) vulnerability in the
map view reply handler. Replies now require a nonce, go through WordPress’s
normal comment checks, filtering and moderation, and all comment fields are
escaped on output. Reported by Enrico Marcolini and Claudio Marchesini
(Dottor Marc).
* Security: fixed a reflected cross-site scripting (XSS) vulnerability in the
same handler’s response, which is now sent as JSON and no longer echoes
request values. Reported by an anonymous security researcher.
* Security: the settings page now checks a nonce and the manage_options
capability, validates the saved values and escapes its output.
* Security: the map view and the knowledge building comments template now
respect password-protected posts and closed comments, and the map view is
only available on posts that use a knowledge type set.
* Security: saving pinned node positions on the map now requires a nonce and
permission to edit the comment.
* Security: escaped the remaining URLs and knowledge type data printed by the
plugin.
* Fixed fatal errors on PHP 8 and on sites that use a persistent object cache.
* Fixed an upgrade routine that could block access to wp-admin.
* Avatars now use the site’s avatar settings and load over https.
* Comments posted through the regular comment form now store their map index
correctly.
* Requires WordPress 5.7 or later and a classic (non-block) theme.
* Tested to work with WordPress 7.1.

=0.7.2=
* Added the comment_form action call to allow other plugins to function that
want to add to comment forms.

=0.7.1=
* Deprecation error fixed.

=0.7=
* Map view ready and optimized.

=0.6=
* A new map view introduced.

=0.5.7=
* Tested to work with WordPress 3.5.1
* IE bug fix

=0.5.4=
* Tested to work with WordPress 3.0.

=0.5.3=
* Tested to work with WordPress 2.9.

=0.5.2=
* Debug messages removed (broke sorting on IE).

=0.5.1=
* Speed optimization to comment sorting.

=0.5=
* Quick fix for database initialization
* Basic support for sorting of comments.

0.4

  • Corrected path dependency to math the installation path given by the WordPress Plugin Directory.
  • Windows-compatible path handling.

0.3

  • Modified colors to be less intensive.
  • Otherwise everything seems to be working smoothly.

0.2

  • Beta release. Main functionality is done, and seems to be working.

0.1

  • Initial alpha version.