Reuse of product and application names

• Reuse product names, application names, and snap-in names. If you do not see a name in the common topic, submit an issue to the Infosolutions project.
• Refer to the Product Naming Rules (CID 150002) for the official product names. Contact your GIS Program Manager or Program Owner for changes to the naming rules.
• Some product teams allow articles to precede the product name and some do not. Consult your GIS Program Manager or Program Owner and the Product Naming Rules document for the correct usage for your product.
• Add the following names in the common topics:
  • Avaya products
  • Applications within Avaya products. This includes mobile application names.
  • Snap-in names
  • Interfaces with their own names. This does not refer to generic names like the web application, but for named interfaces, such as Messaging Web Application for Avaya Aura® Messaging or Web Manager for IP Office.
  Important:

  If your product is localized, before you request IA to add an application name or interface name to the common Applications topic, contact your Localization Project Manager to determine if the name must be localized. Include this information in your request.
• If a product name has been changed, however, if your product still uses the earlier version of the product, select earlier version of the topic with the older name in your publication.
• You should only reuse the common product and application names when referring to the specific product or application. Do not reuse a product or application name when you’re making a generic reference. For example, if you’re talking about the Conferencing product, reuse the name. But if you’re just making a generic reference to the concept of conferencing, type the text and do not reuse the product name. Inappropriate use of the common product and application names is incorrect from a DITA perspective and it also has an impact on localization.

Inline element reuse

• Create separate common topics for the uicontrol and wintitle elements that you reuse. Depending on the complexity of your product and the number of interfaces, you can decide to have separate common topics based on the types of users (for example, administration versus users) or separate interfaces.
• The Localization team requests that you create separate common topics for inline elements that are part of the interface versus those that aren’t. For example, a filename that they double-click during installation must be tagged with uicontrol but it is not an element in the interface. Therefore, the filename must be added in a separate common topic from the actual interface elements. You can contact your Localization team member to request a list of the strings from the interface.
• You must reuse inline elements only where it is semantically appropriate. For example, if a term is used as both a uicontrol and a generic word, reuse only the uicontrol element when it is specifically referencing the interface element and not when it is a generic reference.
• Each project must have a common topic for titles in cite elements.

• emphasis
• indexterm
• pre
• q
• simple-equation
• sstitle
• title
• tm

Document title reuse

• All products must have a topic including the document titles for that product. The common topics are located in Tridion Docs under Common DITA Supporting Content/Project document titles. If you do not see a common topic for a product from where you need to reuse the names, contact the writer for that project. If you don not know the topic owner, consult your Doc Lead or Documentation Manager or create a ticket in the Infosolutions project.
• When you reuse titles from a common topic, the version that you use is important. Always review the Changes field to know the version and ensure that it suits the product release that is appropriate for your product. For example, when writers start work on a new release, they might need to create a new version of the document titles topic to make changes for the new release on which they are working, and they must mention the release number of the product in the Changes field. In this case, you would not use the latest version of the topic because it’s for an unreleased version of the product. If you have any questions about the version of a document titles topic, contact the writer for that project.