Resource ID Naming Standards
The <resourceid> element is a unique identifier used for context-sensitive help. It falls inside the <prolog> element. When first setting up context-sensitive help, a writer must coordinate resources IDs with a developer.Connecting Realm Help Icon to Help Article
A single topic can have multiple Resource IDs, but each Resource ID should only be contained in one topic. In other words, you cannot use the same Resource ID in more than one topic, even if the topic relates to another product. Follow the guidelines below for creating successful Resource IDs.
-
Avoid other symbols like ' and &.
-
Use title case.
-
Use dot format between words.
-
Make sure resource IDs are unique.
-
Append the product name, then module to the beginning of the Resource ID.1
- Enter the application name where the resource id is used For example, "LMS", "system email-2022", etc.
Examples:
-
Realm.Checkin.Setup
-
ACS.Reports
-
MissionInsite.Reports.Mosaic
-
Realm.Communication.Text.Messaging
-
PDS.Giving.Your.Year.End.Checklist
-
MinistryPlatform.Groups.Texting
-
TrustCenter.Secure.Home.WiFi