Document Extensions: Revisions
- Document Revisions are snapshots of documents, that can be created automatically upon document creation, modification, or deletion.
- Revisions can be used for data auditing, instant restoration after document corruption, and various other uses.
The Studio views that this article describes are -
- the Document View Revisions tab, that lists the revisions created for a document and allows to inspect each revision, compare it with other revisions, and create new revisions.
- The Revisions Bin, that holds the revisions of deleted documents.
Find here a dynamic walkthrough that demonstrates revisions management.
In this page:
A document's Revisions tab displays the full trail of revisions created for the document, allowing you to inspect each revision, force the creation of a new revision, and compare revisions to the live document version.
- Document View > Revisions tab
Click to display the document's Revisions tab.
Revisions are listed in the Revisions tab by their creation time signatures.
The current number of revisions is displayed in the tab header.
- Create Revision
Click to create a new revision for this document.
A new revision will be created if the document doesn't already have a revision for the latest content.
Learn here about forcing the creation of a new revision via Studio or the API.
- A Revision
Click to inspect this revision.
- Compare Revision
Click to compare this revision with the current live version of this document.
Click to Inspect
- Click a revision time signature to inspect the revision's contents.
The REVISION label indicates that you are viewing a revision and not the parent document.
Click to create a document that copies the revision's contents.
Cloning the revision will open the 'new document view' with this revision's contents.
You can then save the clone under a new name to create a new document.
Saving the clone with the exact same ID as the revision's parent document will revert the document to this revision.
- See the current document
Click to return to the revision's parent document view.
- Revision Inspection Area
The revision's content, displayed in read-only mode.
Click to Compare
- Click a revision's Comparison button to compare it with other revisions.
- Exit revisions compare mode
Click to exit the comparison window and return to the Revisions tab in the Document View.
- Compare with
Click to select a revision to compare with.
- Left-hand revision
The left-hand view displays the revision selected in the Revisions tab.
- Right-hand revision
The right-hand view displays the revision selected using the "Compare with" drop-down list.
- Summary line
This line summarizes the differences found between the two revisions.
When the Revisions feature is Enabled for a document's collection, and the document is deleted:
- A delete-revision will be created for the document, marking its deletion.
- The delete-revision and all the document's revisions, both Automatically-Created and Manually-Created, will be moved to the Revisions Bin.
When the Revisions feature is Disabled for a document's collection, and the document is deleted:
- The document and all its revisions will be deleted irrevocably.
- Revisions Bin
Click to open the Revisions Bin view.
Each item listed in the Revisions Bin view references all the revisions created for a deleted document.
- Selection Boxes
Check to select items.
Click to remove selected items.
Deleting revisions from the revisions bin will dispose of these revisions irrevocably.
Deleted Document ID
This is the ID of the document that was deleted.
Click it to inspect the revisions created for this document (aka "orphaned revisions" because their parent document has been deleted).
- Revisions stored in the revisions bin can be inspected and cloned just like the revisions of a live document.
- Change Vector
The change vector of the revision that was created for the document when it was deleted.
- Deletion Date
The date/time when the document was deleted.
Giving a new document the ID of a deleted document whose revisions are kept in the Revisions Bin, will restore the revisions from the bin and add them to the new document.
Opening the document's Revisions tab will display the whole audit trail, including the delete-revision created when the old document was deleted and the revision created when the new document was created.