Adds a comments section to Wiki pages. (previous authors: Esther Brunner)
Compatible with DokuWiki
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.
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~~
.
~~DISCUSSION~~ ~~DISCUSSION:off~~ ~~DISCUSSION:closed~~
A custom title can be appended after the separator |.
~~DISCUSSION|Custom Title String~~ ~~DISCUSSION:closed|Custom Title String~~
After each comment in the discussion section there may be up to three buttons (depending on your rights):
Reply
button. The comment entry form will then be placed accordingly.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.
This displays a list of all pages of the given namespace with a discussion section. The list is sorted by the most recent comment.
{{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 |
nonewthreadform | Do not show the new thread form form below the table | optional |
Default a new thread form is shown below the list. See threads_formposition
setting for moving it to the top of the list, or to disable this form.
The plugin can be configured using DokuWiki's configuration manager available in the admin menu.
automatic | automatically enables discussions on all pages |
---|---|
excluded_ns | list of namespaces for which to revert the automatic config setting (a regular expression e.g. /(playground|wiki)/ , delimiter should be included e.g. '/' at start and end ) |
visibilityButton | Enable button for toggling the visibility of the entire discussion section |
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) |
wikisyntaxok | allow wiki syntax in comments1) |
threads_formposition | position of the new thread form shown with the {{threads> }} syntax (before or below the thread listing) |
subscribe | allow comment subscription (uses double opt-in), if page-subscriptions are used it is only used for not-logged users. |
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 ) |
moderatorsnotify | send a notification to all specified moderators whenever a new comment was submitted |
Please report bugs or feature requests at the Bug tracker.
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.
The plugin has built-in support for the CAPTCHA plugin. Additionally, one might also consider to use the Bad Behavior plugin.
Yes, use the newestfirst
config option.
If you enable the notify option admins are notified for all comments.
This is possible using the feed plugin, please see there how it works.
The plugin disables subscription for logged-in users when the option “subscribers” is activated in the configuration, which enables subscriptions for changes per page and/or namespace.
You can overwrite translated strings such as the default title with your own text.
<?php /** * Customization of the english language file * Copy only the strings that needs to be modified */ $lang['discussion'] = 'Discussion';
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.
You can change the size of the box by using the following CSS class:
div.dokuwiki div.comment_wrapper {}
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.
You can list all discussions with:
{{threads>*}}
Beware that hidden comments are not shown. Not even to administrators.
This example
{{threads>:namespace_abc&nouser&header&skipempty&nonewthreadform}}
shows a list of pages inside namespace_abc with
Discussions aren't stored like regular wiki pages. This will not work.
You will need to edit a line in the 'action.php' file which can be found in lib→plugins. Find the following line (281)
$comment['user']['id'] = 'test'.hsc($_REQUEST['user']);
and replace it with
$comment['user']['id'] = 'GUEST: '.hsc($_REQUEST['name']);
I've detailed this issue but am unable to work around the problem that, with my wiki, I can't insert media on pages that also have discussions as the main page edit toolbar is replaced with the reduced toolbar for the discussions.
Please report any bugs or feature wishes in the issue tracker!
For the discussion refer to the discussion page.