DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:discussion

Discussion Plugin

Compatible with DokuWiki

  • 2013-12-08 "Binky" yes
  • 2013-05-10 "Weatherwax" yes
  • 2012-10-13 "Adora Belle" yes
  • 2012-01-25 "Angua" unknown

plugin Adds a comments section to Wiki pages. (previous authors: Esther Brunner)

Last updated on
2013-10-29
Provides
Syntax, Helper, Admin, Action
Repository
Source
Conflicts with
sidebar
Requires
pagelist

Similar to blogtng, disqus, talkpage

Tagged with discussion

Description

The Discussion Plugin adds a discussion section after your wiki page for user comments. This is useful to separate page content and the discussion thereof and also, if you don't want to give normal users the right to edit the page but still want user contributed notes. A second component of this plugin shows a list of all pages in a namespace with a discussion section (called discussion threads) ordered by most recent comments. This allows you to create a very simple discussion forum in your wiki.

Components

Discussion Comments

~~DISCUSSION~~
~~DISCUSSION:off~~
~~DISCUSSION:closed~~
~~DISCUSSION|Custom Title String~~
~~DISCUSSION:closed|Custom Title String~~

This is the main part of the plugin. By including the ~~DISCUSSION~~ instruction in your wiki page, a discussion section will be appended after the normal wiki page content. To turn it off again, use ~~DISCUSSION:off~~. If you want to show the existing discussion but don't want to allow new comments / replies, use ~~DISCUSSION:closed~~. A custom title can be appended after the separator |.

After each comment there may be up to three buttons (depending on your rights):

  • Edit: Registered users can edit their comments; admins can edit all comments. To remove a comment, just edit it, clear the text and save the empty comment – like you would do with a wiki page. Attention: If there are replies to a comment, removing it will also remove all replies!
  • Reply: To reply to a comment (vs. commenting on the wiki page content), click the Reply button. The comment entry form will then be placed accordingly.
  • Hide / Show: Admins can deactivate and reactivate comments easily by this button. Hidden comments aren't shown to normal users and are displayed dimmed to admins.

Of course, the whole DokuWiki syntax can be used in comments as well. But there are problems with headers and footnotes as they may produce conflicting IDs and thus invalid XHTML. I'm looking for a way to either allow only a subset of the wiki syntax or automatically create unique IDs.

Threads

{{threads>[namespace]&[count=n]&[flags]&skipempty}}
[namespace] the namespace for which you want a discussion thread list; : is the top namespace, . is the same namespace as the page lies in, * the whole wiki required
[count=n] the number of discussions which should be displayed (valid values: n > 0) optional
[flags] pagelist flags delimited by &, see flags optional
skipempty Do not print discussions with no comments optional

This displays a list of all pages of the given namespace with a discussion section. The list is sorted by the most recent comment.

Configuration

The plugin can be configured using DokuWiki's configuration manager available in the admin menu.

automatic automatically enables discussions on all pages
allowguests allow/disallow unregistered users to leave comments
showguests show/hide comments to unregistered users
linkmail link username with the supplied mail address
useavatar display avatars (requires the avatar plugin)
urlfield allow to submit a homepage URL (will be linked with the name unless linkmail is set)
addressfield allow to submit a address
adminimport admin can supply all fields (for import only)
usecocomment use CoComment tracking (disabled by default)
wikisyntaxok allow wiki syntax in comments
threads_formposition position of the new thread form (before or below the thread listing)
subscribe allow comment subscription (uses double opt-in)
newestfirst Invert the comments display order
usethreading enable/disable threaded comments
userealname display the real name instead of the user name of registered wiki users
moderate moderate new comments
moderatorgroups add groups to delegate administrative control (e. g. @coadmins,@mods)

Demo

You can try this plugin using the live demoFIXME which shows a blog running on the Dokuwiki blog plugin, in action!

Bugs / Feature Requests

Please report bugs or feature requests at the Bug tracker.

Further Resources

Changes

  • 2013-10-29:
    • Use the current mailer API of DokuWiki, this fixes problems with PHP installations with disabled /e modifier. This makes the plugin incompatible with DokuWiki versions older than Adora Belle (2012-09-10)
    • Fix the unsubscribe link in notification mails for logged in users
    • Re-implemented the enable/disable handling, comments are disabled automatically now when the discussion syntax is removed and automatic discussions are disabled.
    • Translation updates
  • 2013-07-01: Fix the captcha check for logged-in users
  • 2013-06-18:
    • Make the discussion plugin compatible with current versions of the captcha plugin
    • Add the option to specify separate moderator groups for comments
    • Use jQuery instead of the old JavaScript library, this makes the plugin compatible with DokuWiki version Weatherwax
  • 2013-02-15: Security fix (XSS vulnerability), if you are using an older version of the discussion plugin you should upgrade ASAP! :!:

FAQ

How do I allow plugin formatting within discussions?

I have DokuWiki formatting allowed in comments. I also have a LaTeX plugin. <math>\sum_x{x+5}</math> is not rendered within a discussion.

How do I prevent SPAM?

The plugin has built-in support for the CAPTCHA plugin. Additionally, one might also consider to use the Bad Behavior plugin.

My dates are shown wrong. What can I do?

You're probably not running the latest version of the plugin. Try to update to the latest version first.

Is it possible to show the newest entry on top?

Yes, use the newestfirst option.

Can admins subscribe to all discussions?

If you enable the notify option admins are notified for all comments.

Where are discussions saved?

The comments are saved in special meta files inside the <dokuwiki>/data/meta directory. Each page which has a discussion has a corresponding pagename.comments file.

How can I change the discussion box size?

You can change the size of the box by using the following CSS class:

div.dokuwiki div.comment_wrapper {}

Why do comments not appear in the latest changes list?

Because it would break DokuWiki's revisions system.

Alternative: use the pagelist plugin to make an overview of “latest discussion” by using the {{threads>...}} syntax.

When I use the sidebar plugin the discussions disappear.

This is a know problem with the sidebar plugin which needs to be fixed by it's author. If you're looking for working alternatives in the meanwhile I suggest to have a look at the sidebarng plugin.

Is it somehow possible to show all discussions on one page (like in the admin area)?

You can list all discussions with:

{{threads>*}}

i can add tags to a discussion, but they don't seem to end up in the tag cloud, or being noticed by the tag plugin

Discussions aren't stored like regular wiki pages. This will not work.

How can I subscribe to a RSS feed of all discussions or threads

This is possible using the feed plugin, please see there how it works.

No subscribe/unsubscribe to comments for logged-in users

The plugin disables subscription for logged-in users when the option “subscribers” ($conf['subscribers']) is activated in the configuration.

send_redirect() error

When you submit a discussion post, you may get the following error:

Call to undefined function send_redirect()

This is because you're running an older version of dokuwiki that does not support the send_redirect() function. There are a few options to remedy this.

  1. Upgrade to a later version of DokuWiki
  2. Pull the send_redirect() function from the source code of a later version dokuwiki and put it in lib/plugins/discussion/action.php or in inc/common.php
  3. Edit lib/plugins/discussion/action.php file and comment out the call to send_redirect() (around line 306), replacing it with something like this:
print "<html><head><meta http-equiv=\"refresh\" content=\"0,url=$url\"></head><body>Redirecting to <a href=\"$url\">$url</a></body></html>";

Newest development version of the plugin (since pull-request 34) should not have that problem with 2008-05-05 anymore, but not all current features may work with 2008-05-05 (preview and subscription for example).

Wrong URL is used by the plugin manager

After upgrading to “Anteater” the discussion-plugin doesn't work in my DW too. The url of the discussion-plugin has changed. Now, I installed the plugin from this url: Discussion-Plugin and it works fine again. :) (I got help on IRC #dokuwiki) — leolein 2010/11/20 19:40

Prevent displaying ip addresses of guest user

Change the following line (#249) in action.php

$comment['user']['id'] = 'test'.hsc($_REQUEST['user']);

to

$comment['user']['id'] = 'Guest';

Discussion-box appears although it is disabled by ~~Discussion:off~~

I've solved this by changing in syntax/comments.php

if ($match == ':off') $status = 0;
else if ($match == ':closed') $status = 2;  
else $status = 1;

Into

if ($match == ':open') $status = 1;
else if ($match == ':closed') $status = 2;
else $status = 0;

Localization

Discussion/Comments

Please report any bugs or feature wishes in the issue tracker!

Please don't simply add other plugins as conflicts without explaining which part is broken either by reporting an issue (preferred) or explaining it on the discussion page.

For the discussion refer to the discussion page.

plugin/discussion.txt · Last modified: 2013/12/19 02:41 by turnermm