Configuring publication-level security banner text

You can customize the text of publication-level security banner.

About this task

The publication-level security banner text consists of three segments defined by configuration items in the publication_s1000d.xml file. The following table describes each of these configuration items.
Configuration ItemDescription
classificationThis configuration item accepts as its value a translation key representing the S1000D security classification of the publication. When the security banner is displayed, the text associated with this key in the applicable language resources file (resources-xx.prop) is displayed as the first segment of the security banner text.
DistRestrictionCaveat.valueThis configuration item accepts as its value a translation key representing a distribution restriction caveat for the publication. When the security banner is displayed, the text associated with this key in the applicable language resources file is displayed as the second segment of the security banner text.

Alternatively, to use text not represented by a translation key as the second segment of the security banner text, assign this configuration item a value of other. Doing so will display the text specified as the value of DistRestrictionOtherhandling.value as the second segment of the security banner text.

DistRestrictionOtherhandling.valueThis configuration item accepts as its value text to be used if DistRestrictionCaveat.value is assigned a value of other, allowing you to specify custom text to be displayed as the second segment of the security banner text.
distributionThis configuration item accepts as its value any text. When the banner is displayed, the text defined in this item is displayed as the third segment of the security banner text.

Perform the following steps to configure the text for the publication-level security banner.

Procedure

  1. Open the publication_s1000d.xml file for editing.
  2. Locate the Publication element for the publication whose security banner you want to configure. In the following steps, add each configuration item within this element.
  3. Add the classification configuration item to define the security classification of the publication as follows.
    Configuration->Publication->settings="classification=<value>"

    where TextValue1 is a translation key representing the publication's security classification. For a list of the default security classification translation keys, see Default security banner translation keys later in this section.

  4. Add the DistRestrictionCaveat.value configuration item to define the distribution restriction caveat for the publication as follows.
    Configuration->Publication->settings="DistRestrictionCaveat=<value>"

    where TextValue2 is a translation key representing the publication's distribution restriction caveat. For a list of the default distribution restriction caveat translation keys, see Default security banner translation keys later in this section.

    To use custom text instead of a defined translation key value, set the value of TextValue2 to other. Doing so causes the text specified in the DistRestrictionOtherhandling.value configuration item to be used.
  5. Add the distribution configuration item to define the distribution status for the publication as follows.
    Configuration->Publication->settings="distribution=<value>"

    where TextValue3 is any text.

  6. Add the DistRestrictionOtherhandling.value configuration item and set its value to the custom text to be used when the value of DistRestrictionCaveat.value is set to other.
    Configuration->Publication->settings="DistRestrictionOtherhandling=<value>"

    where TextValue4 is custom text to be used as the distribution restriction caveat.

  7. Save and close the publication_s1000d.xml file.