====== EnforceSummary Plugin ======

---- plugin ----
description: Enforce summary or minor change on all edits with optional preview enforcement
author     : Matthias Schulte
email      : dokuwiki@lupo49.de
type       : Action
lastupdate : 2014-02-09
compatible : Lemming, Anteater, Rincewind, angua, adora belle, weatherwax, Binky, Ponder Stibbons, Hrun, Greebo, Hogfather
depends    : 
conflicts  : forcepreview
similar    : 
tags       : editing

downloadurl: https://github.com/lupo49/plugin-enforcesummary/tarball/master
sourcerepo: https://github.com/lupo49/plugin-enforcesummary
bugtracker: https://github.com/lupo49/plugin-enforcesummary/issues
----

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

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


You have to resave the [[plugin:config|Configuration Manager]] or alternatively you have to touch the ''conf/local.php'' (change timestamp) or [[:devel:caching|clear the cache]] to activate the script which is shipped by the plugin.

===== Description =====

Implements two tips of [[tips:Summary Enforcement]] and [[tips:autominor|Minor Edit by default]] as a plugin.
Also supports optional requirement of preview prior to save changes.

===== Configuration =====

The plugin can be configured using the [[plugin:config|Configuration manager]].

^ Config option ^ Description ^
|''**enforce_summary**''\\ (default = 1)    |enable summary enforcement.  |
|''**default_minoredit**''\\ (default = 0)  |set ''Minor Changes'' checked by default. |
|''**enforce_preview**''\\ (default = 0)    |force preview prior to save pages. |


==== Providing site-specific edit guidance ====

The plugin provides "Edit Guidance" below the ''save'' button in the [[:edit_window|Edit Window]] to encourage editors to provide better edit summary text.

The wiki admin can prepare more specific and appropriate guidance in the ''conf/plugin_lang/enforcesummay/<iso>/edit_guide.txt'' file instead of default language file of this plugin. The %%<iso>%% means your [[config:lang|language]] value of your DokuWiki interface.

===== Bugs =====

''**default_minoredit**'' unfortunately doesn't work in Igor.