DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:renderrevisions

renderrevisions Plugin

Compatible with DokuWiki

  • 2025-05-14 "Librarian" unknown
  • 2024-02-06 "Kaos" yes
  • 2023-04-04 "Jack Jackrum" unknown
  • 2022-07-31 "Igor" unknown

plugin Automatic creation of new page revisions when the render output changed

Last updated on
2025-09-12
Provides
Action
Repository
Source

Tagged with rendering, revisions

A CosmoCode Plugin

Usually a new page revision is only created when a user edits a page. And usually the rendered output of a page only changes when its syntax has been edited. However the latter is not always true. The rendered output may change independently from the page source when plugins are used that pull data from other sources like a database, external sites or other wiki pages.

In some business contexts, where pages have to be regularly reviewed, it might make sense to have page revisions reflecting these changes in output, even though the page's source has not been touched.

This is where this plugin comes in. It can automatically create a new page revision whenever the rendered output has been changed from what it was when rendered last for this revision.

Installation

Search and install the plugin using the Extension Manager. Refer to Plugins on how to install plugins manually.

Configuration

Use the configuration manager to configure the plugin.

  • maxfrequency
    • Defines the minimum time that has to be passed since the creation of the last revision of a page before a new one is created. The default is 1 day. This means even for a rapidly changing page, a new revision is only created every day.
  • store
    • When enabled, the rendered output is stored for each revision (up to recent_days days) and can be accessed from the page's revision overview.
  • skipRegex
    • The plugin will not run on any page that matches this regular expression. Pages are prefixed with : for comparison.
  • matchRegex
    • Similar to the above. The plugin will only run on pages that match this regular expression.

Command Line Tool

The plugin is triggered by the normal rerendering of pages when the xhtml cache expires. This rerendering depends on the affected page to be visited. If parts of your wiki are only infrequently accessed, you can force rendering rechecks using the command line tool included with this plugin.

php bin/plugin.php renderrevisions

You might want to set up a cron job for this.

plugin/renderrevisions.txt · Last modified: by andi

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki