====== History Cleanup Plugin ======

---- plugin ----
description: Removes subsequent edits by the same user from old revisions and history entries
author     : Dominik Eckelmann
email      : dokuwiki@cosmocode.de
type       : action, admin
lastupdate : 2023-01-31
compatible : Rincewind, Angua, Adora Belle, Weatherwax, Binky, Ponder Stibbons, Hrun, Detritus, Elenor of Tsort, Frusterick Manners, Greebo, Hogfather, Igor
depends    : 
conflicts  : 
similar    : 
tags       : revisions, maintenance, spam, users, history

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

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

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

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

  * [[https://github.com/cosmocode/clearhistory/zipball/master]]

==== Changes ====

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

===== Usage =====

Access the Admin menu and choose the History Cleanup plugin.

==== Cleanup on last changes ====

The plugin checks all [[:page|pages]] from the [[:recent changes]] page.

==== Configuration ====

In [[:config|configuration manager]], you can also setup the plugin to run automatically once a day.

==== Cleanup on namespace ====

The plugin checks all [[:page|pages]] from a [[:namespaces|namespace]] and it's sub-[[:namespaces]]. If no [[:namespace]] is given it checks all [[:page|pages]]. 

===== Page cleanup process =====

  * The plugin checks for all old versions of a [[:page]].
  * it checks from old to new version.
  * it check always two versions that are back-to-back each other.
  * if the authors are the same and the time span between the versions is lesser then 1 hour the old version will be deleted.

==== Example ====

Here a small example on the [[:DokuWiki]] welcome page history:\\

History before:
  2008/08/16 19:24 DokuWiki – (external edit) (current)
  2008/08/10 15:34 DokuWiki – re-added doku> interwikilink again, because this page gets included in the install tarball andi
  2008/08/10 13:57 DokuWiki – 87.206.233.64
  2008/08/10 13:57 DokuWiki – 87.206.233.64
  2008/08/10 07:10 DokuWiki – 93.135.108.77
  2008/08/10 07:10 DokuWiki – 93.135.108.77
  2008/08/09 13:57 DokuWiki – fixed links, page seems clean 82.224.163.148

History after:
  2008/08/16 19:24 DokuWiki – (external edit) (current)
  2008/08/10 15:34 DokuWiki – re-added doku> interwikilink again, because this page gets included in the install tarball andi
  2008/08/10 13:57 DokuWiki – 87.206.233.64
  2008/08/10 07:10 DokuWiki – 93.135.108.77
  2008/08/09 13:57 DokuWiki – fixed links, page seems clean 82.224.163.148

===== TODO and suggestions =====

  * Add a function to automatic delete old history data that is older then a specific value in days (like [[tips:maintenance#automatic_cleanup_script]])
  * Add a function to automatic cleanup the playground (like [[tips:maintenance#keeping_playground_clean]])
  * I miss some flexibility. Instead of merging history entries by the same user within 1 hour, I'd like to keep 1 history entry per month or per year, regardless of who edited it last. A draft new version is available in the forum: [[http://forum.dokuwiki.org/post/33457]]  --- [[user>quadra|quadra]] //2012/07/13 13:52//
  * Selective removal of versions would be nice

===== See also =====

  * [[tips:maintenance]]