dvrResourceSuffix

Darwin Information Typing Architecture (DITA) Version 1.3 Part 3: All-Inclusive Edition

version
1.3
author
OASIS DITA Technical Committee

The dvrResourceSuffix element specifies the suffix to use when constructing the effective file names of resources that are referenced from within the map branch that is implied by the ancestor ditavalref element.

For map branches that are implied by ditavalref elements, the value of the dvrResourceSuffix element contributes to the effective file names of the resources that are referenced within the branch. The base part of the effective resource file name ends with the value of the dvrResourceSuffix element. The base part of the resource file name consists of the portion of the file name after any directory information, and before any period followed by the file extension. For example, in the original file name task/install.dita, the base portion of the file name is "install". If copy-to is specified on a topic reference where dvrResourcePrefix or dvrResourceSuffix based renaming is in effect, the prefixes or suffixes are applied to the resource name inside the copy-to attribute.

Some resources are not eligible for renaming, such as those marked with scope="external". Rules for which resources are eligible for renaming, and what names are allowed as valid resource names, are the same as those for the copy-to attribute defined in Topicref element attributes group, with one exception. Where copy-to and dvrResourcePrefix might include path information, path information is not valid in dvrResourceSuffix.

Content models

See appendix for information about this element in OASIS document type shells.

Inheritance

+ topic/data ditavalref-d/dvrResourceSuffix

Example

If the dvrResourceSuffix is specified in the following way:
<topicref href="branch-01.dita">
  <ditavalref href="condition-01.ditaval">
    <ditavalmeta>
      <dvrResourceSuffix>-cond01</dvrResourceSuffix>
    </ditavalmeta>
  </ditavalref>
  <topicref href="topics/subtopic-01.dita"/>
</topicref>

Then the effective file name of resource topics/subtopic-01.dita is topics/subtopic-01-cond01.dita, as though the copy-to attribute had been specified with that value on the topicref to topics/subtopic-01.dita. Similarly, the effective file name of resource branch-01.dita is branch-01-cond01.dita.

Attributes

The following attributes are available on this element: Universal attribute group (except for conkeyref, which is removed for all elements in this domain) and the attribute defined below.

name
The name of the metadata item. For this element the default value is "dvrResourceSuffix".