About Version Control

User Favorite Module

Version control features for page content.

Category 1Admin Helpers
Admin helper modules are those that provide helpful tools, UI enhancements or optimizations to the admin panel (excluding Fieldtype or Inputfield modules).
Category 2Logs/Monitoring
Modules that maintain activity logs or monitor and report activity in some form or another.
Category 3Process Modules
Process modules are apps that run in the ProcessWire admin.
Release StateStable
Should be safe for use in production environments. *
Authorteppo
Module Version1.2.8
Class NameVersionControl
Compatibility2.4, 2.5, 2.6, 2.7, 3.0
Date AddedMay 10, 2014
Last UpdatedFebruary 14, 2017
Recommended ByNew recommendations may take up to 1 day to appear.

Instructions

This module's files should be placed in /site/modules/VersionControl/
How to install or uninstall modules

README

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 storeshistory 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 fieldsto 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 whichopens 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 eitherdon'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

If a specific fieldtype isn't listed here, it doesn't necessarily mean thatit'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 reallystarts 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 theoperations 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 underthe 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/ormodify 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 Licensealong 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.)

Comments

No comments yet. Be the first to post!

Post a Comment

Your e-mail is kept confidential and not included with your comment. Website is optional.