VersionControl by Teppo

Version control features for page content.

Version Control For ProcessWire CMS/CMF

Version Control Module For ProcessWire CMS/CMF. Copyright (c) 2013-2016 Teppo Koivula

This module uses hooks provided by ProcessWire to catch page edits and stores history data in a series of custom database tables, so that it can be later retrieved, reviewed, and restored.

Note that at module settings you can define which specific fieldtypes and fields to track and for which templates tracking values should be enabled. Right out of the box tracking is disabled for all templates and fields.

While editing a page with version control enabled, revision toggle (link which opens list of previous revisions) is shown for fields with earlier revisions available. From this list user can select a revision and rollback value of the field to that specific revision.

Supported fieldtypes and inputfields


All native ProcessWire fieldtypes and inputfields, apart from those that either don't directly store values at all (repeaters fields, fieldsets) or only store hashed values (password), should be supported by the time of this writing:

  • Email
  • Datetime
  • Text (regular and multi-language)
  • Textarea (regular and multi-language)
  • Page Title (regular and multi-language)
  • Checkbox
  • Integer
  • Float
  • URL
  • Page
  • Module
  • File
  • Image
  • Selector
  • Options

Supported third party fieldtypes:

  • ProFields Textareas

If a specific fieldtype isn't listed here, it doesn't necessarily mean that it's not supported; it just hasn't been tested yet. If you know a fieldtype that works properly with this module but isn't included here, please inform the author of this module via GitHub.

You can enable support for any installed fieldtypes locally by modifying the "Compatible fieldtypes" setting, which can be found under "Advanced Settings" in module configuration screen.

Following inputfields are confirmed to be supported:

  • TinyMCE
  • CKEditor (regular and inline mode)
  • Text (+ other inputfields using <input> HTML element, such as Email)
  • Textarea (+ other inputfields using regular <textarea> HTML element)
  • Select
  • File
  • Image
  • Selector

Requirements


Please note that this module requires ProcessWire 2.4.1 or a later version. If you're still running an earlier version of ProcessWire and would like to have a similar feature, please take a look at the Version Control for Text Fields module: https://github.com/teppokoivula/VersionControlForTextFields.

Getting started


Copy (or clone with git) VersionControl folder to /site/modules/, go to Admin > Modules, hit "Check for new modules" and install Version Control. Supporting modules Process Version Control and Page Snapshot are installed automatically.

After installing this module you need to configure it before anything really starts happening. Most configuration options (essentially templates and fields this module is switched on for) can be found from Admin > Modules > Version Control (module config.) Minor settings can be found from related Process modules config: Admin > Modules > Process Version Control.

Diff Match and Patch


The Diff Match and Patch libraries offer robust algorithms to perform the operations required for synchronizing plain text. In the scope of current module, the JavaScript implementation of Diff Match and Patch is used to render diff between different revisions of a field value.

Diff Match and Patch is copyright (c) 2006 Google Inc. and released under the Apache License, Version 2.0. For more information about this library, please visit http://code.google.com/p/google-diff-match-patch/.

License


This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

(See included LICENSE file for full license text.)

Install and use modules at your own risk. Always have a site and database backup before installing new modules.

Twitter updates

  • ProcessWire 3.0.185 (dev) core updates, plus new Session Allow module— More
    17 September 2021
  • Three new ProcessWire Textformatter modules: Find/Replace, Markdown in Markup, and Emoji— More
    3 September 2021
  • This week we have a new master version released after a year in the making. With nearly 40 pull requests, hundreds of new additions and more than 100 issue reports resolved, this new version has a ton of great new stuff— More
    27 August 2021

Latest news

  • ProcessWire Weekly #388
    In the 388th issue of ProcessWire Weekly we'll check out the latest core update, introduce two new third party modules, and more. Read on!
    Weekly.pw / 16 October 2021
  • ProcessWire 3.0.184 new master/main version
    This week we have a new master/main version released after a full year in the making. As you might imagine, this new version has a ton of great new stuff and we’ll try to cover much of it here.
    Blog / 27 August 2021
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK