<dvrResourceSuffix>

The <dvrResourceSuffix> element specifies the prefix to use when constructing the effective file names or resource IDs of the resources that are referenced from within the map branch that is implied by the ancestor <ditavalref> element.

Processing expectations

For map branches that are implied by <ditavalref> elements, the value of the <dvrResourceSuffix> element contributes to the effective file names and resource IDs 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 a topic reference includes <resourceid> with the @appid-role attribute set to deliverable-anchor, the effective @appid value for that <resourceid> value ends with the value of the <dvrResourceSuffix> element.

Path information is not valid in <dvrResourceSuffix>.

Some resources are not eligible for renaming, such as those marked with scope="external".

Specialization hierarchy

The <dvrResourceSuffix> element is specialized from <data>. It is defined in the DITAVAL-reference domain module.

Content model

(Text | <text> )*

Zero or more

Attributes

The following attributes are available on this element: universal attributes (except for @conkeyref, which is removed for all elements in this domain) and @name.

For this element, the @name attribute has a default value of dvrResourcSuffix.

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

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

@name
The name of the metadata item. For this element the default value is "dvrResourceSuffix".
Defines a unique name for the object.
For this element, the @name attribute has a default value of dvrResourcSuffix.

Example

This section is non-normative.

Example 1. How <dvrResourceSuffix> affects resource file names
The following code sample shows a simple branch with a parent and child topic, where the branch uses a <ditavalref> element and <dvrResourceSuffix>.
<topicref href="branch-01.dita">
  <ditavalref href="condition-01.ditaval">
    <ditavalmeta>
      <dvrResourceSuffix>-cond01</dvrResourceSuffix>
    </ditavalmeta>
  </ditavalref>
  <topicref href="topics/subtopic-01.dita"/>
</topicref>
After the <ditavalref> is evaluated:
  • The effective file name of the resource subtopic-01.dita is subtopic-01-cond01.dita.
  • The effective file name of resource branch-01.dita is branch-01-cond01.dita.
Example 2. How <dvrResourceSuffix> interacts with <resourceid>
The following code sample shows the same branch with a parent and child topic, but in this case the child topic specifies a deliverable anchor with <resourceid>.
<topicref href="branch-01.dita">
  <ditavalref href="condition-01.ditaval">
    <ditavalmeta>
      <dvrResourceSuffix>cond01-</dvrResourceSuffix>
    </ditavalmeta>
  </ditavalref>
  <topicref href="topics/subtopic-01.dita">
    <topicmeta>
      <resourceid appid="ae35-unit-fault" appid-role="deliverable-anchor"/>
    </topicmeta>
  </topicref>
</topicref>
After the <ditavalref> is evaluated:
  • The effective file name of the resource subtopic-01.dita is subtopic-01-cond01.dita.
  • The effective file name of resource branch-01.dita is branch-01-cond01.dita.
  • The effective value of @appid on <resourceid> for the child topic is ae35-unit-fault-cond01.