<resourceid>
The @appid and @appname attributes are available to associate an ID with an application. Multiple @appid values can be associated with a single @appname value, and multiple @appname values can be associated with a single @appid value. Because the values for the @appid and @appname attributes work in combination to specify a specific ID for a specific application, each combination of values for the @appid and @appname attributes should be unique within the context of a single root map.
Versions of DITA before 1.3 used the @id attribute on the <resourceid> element to specify an ID for an external application. Beginning with DITA 1.3, this use of the @id attribute is deprecated in favor of using the @appid attribute.
Content models
See appendix for information about this element in OASIS document type shells.
Inheritance
- topic/resourceid
Example
In the following example, user-assistance context hooks are applied to three topics that are referenced from a DITA map. The second topic has two hooks for the same topic.
<map title="Widget Help">
<topicref href="file_ops.dita" type="concept">
<topicref href="saving.dita" type="task">
<topicmeta>
<resourceid appname="ua" appid="1234" ux-context-string="idh_filesave"
ux-source-priority="topic-only" />
</topicmeta>
</topicref>
<topicref href="deleting.dita" type="task">
<topicmeta>
<resourceid appname="ua"
appid="2345" ux-context-string="idh_filedelete" />
<resourceid appname="ua"
appid="6789" ux-context-string="idh_filekill" />
</topicmeta>
</topicref>
<topicref href="editing.dita" type="task">
<topicmeta>
<resourceid appname="ua"
appid="5432" ux-context-string="idh_fileedit" ux-windowref="csh" />
</topicmeta>
</topicref>
</topicref>
</map>
In the following example, a user-assistance context hook is defined in the prolog of a task topic. The context hook is made up of a context ID (value for @appid attribute) and a context string (value for @ux-context-string attribute). A user-assistance window profile also is referenced for this topic.
<task id="fedt">
<title>Editing a File</title>
<prolog>
<resourceid appname="ua"
appid="5432" ux-context-string="idh_fileedit" ux-windowref="csh" />
</prolog>
<taskbody>
<context>After you have created a new file, you can edit it.</context>
<steps>
<step><cmd>Open...</cmd></step>
<step><cmd>Edit...</cmd></step>
<step><cmd>Save...</cmd></step>
</steps>
</taskbody>
</task>
Attributes
The following attributes are available on this element: Universal attribute group (with a narrowed definition of @id, given below) and the attributes defined below.
- @id
- Before DITA 1.3, this attribute specified a value that was used by a specific application to identify the topic. That usage is deprecated in favor of using the @appid attribute. This attribute is defined with the XML Data Type CDATA.
- @ux-context-string
- Contains the value of a user-assistance context-string that is used to identify the topic.
- @ux-source-priority
-
Specifies precedence for handling <resourceid> definitions that exist in both a map and a topic. This attribute only is valid when used within a <topicref> element in a map. The allowable values are -dita-use-conref-target and the following:
- topic-and-map
- Use IDs from both the topic and map.
- topic-only
- Use IDs from the topic only.
- map-only
- Use IDs from the map only.
- map-takes-priority
- Use the IDs from the map (if they exist); otherwise, use IDs from the topic.
- topic-takes-priority
- Use the IDs from the topic (if they exist); otherwise, use IDs from the map.
- @ux-windowref
- References the @name attribute on the <ux-window> element that is used to display the topic when called from a help API.