Product Names and Types
Use keyrefs to insert the product name ("Realm" or "Realm Office") or type ("church" or "office") in a topic. This eliminates the need for product-related filtering.
Keyrefs are contained within a <ph> element, so they can be inserted anywhere a <ph> is allowed.
Product Name Keyrefs
Instead of writing "Realm" or "Realm Office" in a topic, insert the following:
Realm / Realm Office
This displays "Realm" for non-Network and Church/Network clients and displays "Realm Office" for Office/Network clients.
EXAMPLE:
"In [ Realm / Realm Office ], administrators and staff can view and manage information..."
Product Type Keyrefs
Instead of writing "church" or "office" (or any variation of those terms) when referring to the type of Realm site, insert one of the following:
church / office
This displays "church" for non-Network and Church/Network clients and displays "office" for Office/Network clients.
EXAMPLE:
"If your [ church / office ] has a Canadian address, you can generate a Canadian Tax Statement."
Church / Office
This displays "Church" for non-Network and Church/Network clients and displays "Office" for Office/Network clients.
EXAMPLE:
"[ Church / Office ] groups, staff groups, and pending gifts are not included in these statistics."
churches / offices
This displays "churches" for non-Network and Church/Network clients and displays "offices" for Office/Network clients.
EXAMPLE:
"Most [ churches / offices ] conduct background checks to meet their responsibility..."
church's / office's
This displays "church's" for non-Network and Church/Network clients and displays "office's" for Office/Network clients.
EXAMPLE:
"You may have already changed the name of the Sacraments tab to better fit your [ church's / office's ] terminology..."
church-wide / office-wide
This displays "church-wide" for non-Network and Church/Network clients and displays "office-wide" for Office /Network clients.
EXAMPLE:
"The most common uses for this group are to issue [ church-wide / office-wide ] emails and record worship attendance."
Be Careful!
Watch out for instances where one term may make sense but the other does not, such as "church worship".
Be careful about general use of the word "office" (meaning "church office") as this may be misleading to Office clients. Note that "church" is sometimes used for Office help to refer to the churches in their network. Do not use the keyref in this case or else it will show "office" instead.
Before using a keyref, make sure both products (Network and non-Network) includes the feature you're writing about. If it's only for Realm and not Realm Office, just enter "Realm" instead of using the keyref. (Make sure to filter the content, too, as needed.)
Some UI elements don't use "Realm Office", so don't use the keyref in those instances. EX: "Invite to Realm", "Realm Hardware Utility").
Do not use the keyref for church/office in Inform-only topics. Offices always use the Connect package (although we don't tell them that explicitly).
Do not use keyrefs in image alt text.
Avoid the possessive form of "Realm's".
Exceptions
Right now, we do not have keydefs for the following. We will consider these in a later update.
Realm Accounting Realm Payroll Realm Giving Realm Inbox
Realm Chat
Realm Connect app