====== recommend Plugin ======

---- plugin ----
description: Allows to recommend a page via email
author     : Adrian Lang, Andreas Gohr, Anna Dabrowska
email      : dokuwiki@cosmocode.de
type       : action, admin
lastupdate : 2023-05-23
compatible : Igor
depends    : 
conflicts  : 
similar    : infomail, groupmail
tags       : recommend, email, ajax

downloadurl: https://github.com/cosmocode/recommend/zipball/master
sourcerepo : https://github.com/cosmocode/recommend
bugtracker : https://github.com/cosmocode/recommend/issues
----

===== Download and Installation =====

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

Download and install the plugin from [[https://github.com/cosmocode/recommend/zipball/master]]. Refer to [[:Plugins]] on how to install plugins manually.

==== Changes ====

{{rss>https://github.com/cosmocode/recommend/commits/master.atom date}}

===== Usage =====

The plugin integrates well into page tools. After clicking on the "Send recommendation" icon, the user sees a modal window with input fields for recipient(s), subject and comment. The comma separated list of recipients can include emails, usernames or user groups.

See the instructions in section [[#admin_interface]] on how to pre-define the values in the recommendation form.

The complete recommendation email includes a text from a template and the comment entered by the user. You can change, localize or remove the comment by creating the file ''/conf/plugin_lang/recommend/[YOUR_LANGUAGE]/template.txt'' as described in the [[doku>localization#changing_some_localized_texts_and_strings_in_your_installation
|localization guide]].

You can use a few placeholders in your mail template:

^Placeholder^Replacement^
|@PAGE@| id of the recommended page |
|@SITE@| name of your wiki |
|@URL@| full url |
|@COMMENT@| comment from the from |
|@AUTHOR@| name of the user making the recommendation |


===== Configuration =====

The plugin has a default setting ''wikionly'', which means recommendations are sent only to wiki users. By disabling it in plugin configuration you can allow users to send recommendations to arbitrary email addresses.

===== Admin interface =====

The admin interface displays a log of sent recommendations and provides a form for pre-defining recommendation subjects, messages and recipients. Those will be pre-filled in the recommendation form and can be edited by the user before they send the mail.

Admins can define different default values per page or namespace by using full page ids or id patterns:
  * ''namespace:**'' for all sub-namespaces of any depth
  * ''namespace:*'' for the immediate sub-namespace only
  * regular expressions

Be aware that the rules for the current page are matched from top to bottom, and the last matching rule "wins".

===== Discussion =====

  * <del>Would be great if the plugin could provide its features in different languages. But thanks for this plugin anyway!</del>
    * Version 2022-11-23 uses the usual localization mechanism and can be translated just as any other plugin.
    * The page with a Chinese name cannot be sent.