====== FeedBack Plugin ======

---- plugin ----
description: Simple plugin to ask users to provide feedback on wiki pages
author     : Andreas Gohr 
email      : dokuwiki@cosmocode.de 
type       : action
lastupdate : 2019-03-21
compatible : Frusterick Manners
depends    : 
conflicts  : 
similar    : 
tags       : mail, feedback

downloadurl: https://github.com/cosmocode/dokuwiki-plugin-feedback/zipball/master
bugtracker : https://github.com/cosmocode/dokuwiki-plugin-feedback/issues
sourcerepo : https://github.com/cosmocode/dokuwiki-plugin-feedback
donationurl: 

screenshot_img : 
----

[[https://www.cosmocode.de/en/open-source/dokuwiki-plugins/|{{ http://cosmocode.de/static/img/dokuwiki/dwplugins.png?recache|A CosmoCode Plugin}}]]

===== Installation =====

Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.

===== Integration =====

==== By Syntax ====

You can add the Feedback Link to your sidebar using the following syntax:

  {{FEEDBACK}}

==== By changing the template ====

You can integrate the link directly into the template using the following code:

<code php>
<?php
/** @var action_plugin_feedback $feedback */
$feedback = plugin_load('action', 'feedback');
if($feedback) $feedback->tpl();
?>
</code>

===== Adjusting the Mail =====

The mail you get when feedback is sent, is defined in the [[https://github.com/cosmocode/dokuwiki-plugin-feedback/blob/master/lang/en/mail.txt|mail.txt]] language file. You can create your own version of that file in ''conf/plugin_lang/feedback/<language>/mail.txt''.

The followoing placeholders can be used in that file:

  * PAGE - the page on which the feedback was given
  * FEEDBACK - the feedback provided
  * URL - the URL of the page where the feedback was given
  * DATE - current date
  * BROWSER - the browser used by the user giving feedback
  * IPADDRESS - ip address of the user
  * HOSTNAME - host name for above IP address
  * TITLE - title of the wiki
  * DOKUWIKIURL - URL of the wiki
  * USER - user name of the user giving feedback
  * NAME - name of the user
  * MAIL - email address of the user


===== Admin Backend =====

The admin backend allows you to configure e-mail addresses for namespaces that shall allow feedback. User feedback is sent to that address.