Understanding version control

Version control (or versioning) refers to the ability of TEXTML Server to keep multiple previous versions of documents.

You can enable or disable version control for each document base.

If version control is enabled:

  • Each version of a document is identified uniquely by its version number.
  • The first version of a document is version number 1. The current version is the version with the highest version number. Each successive version of a document is given a version number by incrementing the current version number.
  • A version number is not guaranteed to be one greater than its predecessor: if there are four versions of a document numbered 1, 2, 3, 4, and number 2 is deleted, then the remaining documents are numbered 1, 3, 4.
  • To roll back a document to an earlier version, you must first retrieve the earlier version, then add it again—either replacing or retaining the "old" current version.

If version control is not enabled:

  • You can only add new documents and replace old documents. You can, however, have many similar documents, but each must have its own document name (its unique identifier).
  • Each document has only one version, and that version is the current version.
  • Each document has a version number. Replacing a document increments the version number, but does not keep any previous versions.

Version control options

You can configure several version control options for each docbase. They control how versioning is performed if version control is enabled.

These options are often called the default options for versioning, because when your program adds or replaces documents you can either:
  • Accept the default options.
  • Override the default options by setting one or more version control flags.

This section explains how to enable and disable version control; how to set the default options; how to create new versions of existing documents; and how to manage multiple versions of a document.