DITA Prolog Updater Add-on

The DITA Prolog Updater add-on provides options for updating the prolog section of DITA topics and maps.

Compatibility:

This add-on is compatible with the following products:

Oxygen XML Editor
Oxygen XML Author
Oxygen XML Developer

This add-on contributes a preferences page (Options > Preferences > Plugins > DITA Prolog Updater) that includes various options for updating the prolog section of a DITA topic or map.

Edit online

Quick Installation

You can drag the following Install button and drop it into the main editor in Oxygen to quickly initiate the installation process:

Install

Edit online

Manual Installation

To manually install the add-on, follow these instructions:

Go to Help > Install new add-ons to open an add-on selection dialog box.
Enter or paste https://www.oxygenxml.com/InstData/Addons/default/updateSite.xml in the Show add-ons from field or select it from the drop-down menu.
Note:
If you have issues connecting to the default update site, you can download the add-on package, unzip it, then use the Browse for local files action in the Install new add-ons dialog box to locate the downloaded addon.xml file.
Select the DITA Prolog Updater add-on and click Next.
Read the end-user license agreement, then select I accept all terms of the end-user license agreement and select Install.
Restart the Oxygen application.

Result: The DITA Prolog Updater preferences page will now be available in Options > Preferences > Plugins.

Edit online

DITA Prolog Updater Preferences Page

The contributed preferences page (Options > Preferences > Plugins) includes the following general options:

Author: Specifies the name of the author. By default, it is the system user name.
Date format: Specifies the format of the date that will be added in the prolog section. If the date format entered is invalid, the yyy/MM/dd format is used by default.
Limit the number of revised dates to: Specifies the number of revisions that will be kept. Anytime a <revised> element is added in the prolog section and the specified limit has been reached, the oldest <revised> element is deleted.
Custom type attribute value for the original author: Specifies a custom value for the type attribute of the <author> element that is inserted to emphasize the primary or original author of the content. When is not set, the creator value is used.
Custom type attribute value for an additional author: Specifies a custom value for the type attribute of the <author> element that is inserted to emphasize an additional author who is not the primary/original author. When is not set, the contributor value is used.

These options are followed by the following options that can be set for DITA topics or maps (or both):

Enable automatic prolog update on save: When this option is selected, the prolog is updated anytime the document is saved.
Set original author: When this option is selected, the primary or original author is set in the prolog when the document is saved. This option is only applicable for new documents.
Set created date: When this option is selected, a created date is added to the prolog when the document is saved. This option is only applicable for new documents.
Update additional authors: When this option is selected, an additional author is set in the prolog when the document is saved. This option is only applicable for already existing documents.
Update revised dates: When this option is selected, a revised date is added to the prolog when the document is saved. This option is only applicable for already existing documents.