# DITA Best Practices : Project Names ConRef

Created by Kelly Mankenberg on Jul 22, 2013

# What is the Project Names Conref?

For those who are unaware, this conref (Content Reference) file is provided as an easy method to reuse a product’s official name across all XML documentation, and to easily modify it should the product name change (yes, this does happen, especially in the early development stages).

To insert a Product Name conref:

1. Place the editing cursor in the xml document you need to insert your product’s name, and click the Insert Content Reference button.
   Or select DITA > Insert Content Reference.
2. In the URL field of the Insert Content Reference dialog, browse to and select the cmn_project_names.dita file.
3. On the left side is the Target ID list. Locate and select the product you with to insert and click OK.
   IMPORTANT: Notice that there are two instances of your product in the Target ID list. See Which Target Should I Select? below for the distinction.
   The keyword tag is inserted into your document.

# Which Target ID Should I Select?

This is where the current change has appeared. There are times when you will need to reference another product name in your product’s documentation. To accommodate this, a second instance of your product’s Target ID has been created that does not include any product-specific markup.

To illustrate this; I want to include the Admin product title in my IRAMC document. If I select the first WKFS Admin Target ID, keyword [wkfs-admin] (which has the product value of “wkfs-admin”):

The insert would appear as follows:

Notice the inserted conref is disabled. This is because my transformation scenario for IRAMC does not include the “wkfs-admin” product value. If I were to transform this, there would be a blank space where the Wolters Kluwer Financial Services Administration title should be.

In order to have the Admin name displayed, I would need to select the Target ID of keyword [wkfs-admin_name]. This item does not have a product value assigned to it, meaning that it would show up in any product’s transformation. It will appear in oxygen as follows:

Notice the keyword is now enabled.

## Attachments:

clip_image006.gif (image/gif)
clip_image007.jpg (image/jpeg)
clip_image008.jpg (image/jpeg)