sysadmin revisionsystem
Melody supports a robust framework for automatically keeping track of changes made to entries and templates. There are a number of things to consider when using this framework and this is what this document is aimed at addressing.
By default the revision system is disabled within Melody. Users can elect to begin tracking revisions by navigating to their blog's preferences screen, going to the General tab, and checking the checkbox next to Enable Revision Histories.
System administrators can forcibly disable all revisions by using the TrackRevisions config directive (see below).
Within the administrative interface, the revision system can be turned on and off at a global level, or on a blog-by-blog level.
By default Melody tracks revisions for entries, pages and templates only.
Once an entry, page or template has been created and saved, and edits have been made, users can click the "View Revisions" link typically found in the right hand sidebar of the Edit page for the entry/page/template in question. Clicking on that link will cause a dialog to open that displays the entire change log for the content in question. To revert to a previous version, simply click on the revision's date and the dialog will close and the editor will be refreshed with the version you clicked on.
When reverting to a past version, Melody will restore the entire state of the object - not just the text of the object in question.
Whenever a user makes an edit to an entry, page or template, they are encouraged (but not required) to attach a brief note describing what they did. This helps others get a sense for the nature of the change without having to revert to a previous version to view it.
Users can control how many revisions are stored for all objects by navigating to Blog Settings screen under the Preferences Menu. There under the General tab they can set the preferred max number of revisions stored for templates and pages/entries.
The following configuration directives can be used in your config.cgi file to control aspects of Melody's revisioning system.
-
TrackRevisionsThe TrackRevisions config directive turns on and off revision control. It is intended for use by system administrators who do not want to make the feature available to users. If turned off, then the revision component will be forcibly disabled regardless of any other preference previous saved. Default: "1" (on). -
RevisioningDriverThe RevisioningDriver designates the system by which Melody will store and track revisions. By default revisions are stored in the database, and most of the time one would not need to change this value. Default: "Local".
Questions, comments, can't find something? Let us know at our community outpost on Get Satisfaction.
- Author: Arvind Satyanarayan
- Edited by: Byrne Reese, Violet Bliss Dietz