Create an attribute to be a component identifier

Inspire tags components with the schema standard you are using to create your documentation by storing the schema version in an attribute called Identifier.

You must have Administrator permissions to manage attributes.

A schema standard is a set of rules and specifications for structuring and organizing technical documentation using XML.

  • When authors are creating content, they can use the features in the schema standard you are using.
  • For example, some versions of DITA schemas and how they differ:

    • DITA 1.2: Approved in December 2010, this version introduced key features like indirect linking with keys, enhanced glossary support, and new industry specializations like Training and Machinery.

    • DITA 1.3: Approved in December 2015, this version adds features such as branch filtering, the troubleshooting topic type, scoped keys, and support for MathML and SVG.

Inspire tags elements in a component with the schema standard you are using to create your documentation in the following ways:

  • DITA components: stored in the <id> attribute
    • If the Schema Standard you are using is DITA_1.3, this value is stored in <id>
    • This <id> is added to all elements in the component
  • DocBook components: stored in the <xml:id> attribute
    • If the Schema Standard you are using is DocBook5, this value is stored in <xml:id>
    • This <xml:id> is added to all elements in the component

Rules for component identifiers:

  • There must be only one attribute that is the DITA component identifier.
    • Inspire provides one for DITA (<id>).
    • If you want to create your own component identifier attribute for DITA, you must update the default attribute to clear the Identifier option.
  • There must be only one attribute that is the DocBook component identifier.
    • Inspire provides one for DocBook (<xml:id>).
    • If you want to create your own component identifier attribute for DocBook, you must update the default attribute to clear the Identifier option.
  • It is not possible for an attribute to be both a component identifier and a language identifier.

To create an attribute to be a component identifier:

  1. Sort the attribute list to find any other attribute that has the Identifier property.
  2. If another attribute that has the Identifier property, remove it.
  3. Do one of the following:

Sort the attribute list

You can list the attributes in order by Identifier to see if any other attribute already has the Identifier property. In Inspire, you can only configure one attribute to be a DITA identifier and only one different attribute to be a DocBook identifier.

To sort the attribute list:

  1. From the Administration menu, select Advanced Settings, and then Attribute Management.
  2. Next to the column named Identifier, click the drop-down arrow and select Sort Descending.

  3. Check the Identifier column to see if any other attribute has a value of Yes.

    Keep in mind that Inspire provides the following attributes by default as a component identifier:

    • DITA components: stored in the <id> attribute
    • DocBook components: stored in the <xml:id> attribute
    • You can clear the Identifier option in these attributes
    • You can delete the attributes that Inspire provides, but you must have at least one with the Identifier property for DITA and DocBook

Optionally, remove the Identifier property from an existing attribute

If you want to create your own component identifier attribute or update an existing one to include the Identifier property, you must update the attribute that currently includes the Identifier option.

Rules for component identifiers:

  • There must be only one attribute that is the DITA component identifier.
  • There must be only one different attribute that is the DocBook component identifier.
  • It is not possible for an attribute to be both a component identifier and a language identifier.

To remove the Identifier property from an existing attribute:

  1. On the Attribute Management tab, select the attribute that has the Identifier property.
  2. At the end of the attribute's row, click Update.

    Result: The Update attribute screen opens.

  3. Clear the checkbox for Identifier.
  4. Click Update.

    Results: Administrators can see the updated attribute on the Attribute Management tab in the list of attributes.

Create a new attribute with the Identifier property

If you want to add the Identifier property to an attribute that doesn't exist yet, you can create a new attribute. You can add the Identifier property while creating a new attribute.

Rules for component identifiers:

  • There must be only one attribute that is the DITA component identifier.
  • There must be only one different attribute that is the DocBook component identifier.
  • It is not possible for an attribute to be both a component identifier and a language identifier.

To create a new attribute with the Identifier property:

  1. On the Attribute Management tab, click Create.

    Result: The Create new attribute screen opens.

  2. Enter a unique Name using 100 characters or less.

    Important:

    • This is a system name, so you cannot use spaces or special characters
    • The name must be different from any system-created names, like <id>, <xml:id>, or <xml:lang>
  3. Optionally, you can create a similar Display Name that's more user-friendly.

    Notes:

    • Use 100 characters or less
    • This is the name an author will see when selecting an attribute in the Oxygen editor
    • If you don't enter a Display Name, the system Name is shown instead
  4. In Schema Standard, select the schema version that must be used to validate the attribute. For example, DITA_1.3.
  5. Select Identifier.

    Important:

    • It is not possible for an attribute to be both a component identifier and a language identifier.
    • If you select the Identifier option, there must be no other attribute that already has this property.
    • If you select the Identifier option, you cannot also select the Language option.
    • For more information, refer to: Why do I need an attribute that is a component identifier?
  6. To create the attribute, click Create.
    Results:
    • Administrators can see the new attribute on the Attribute Management tab in the list of attributes.
    • Administrators can select the attribute from the lists on the XML Link Type Configuration screens.
    • Inspire adds the Identifier to all elements in a component.
    You can repeat these steps so that you have:
    • One attribute that is the DITA component identifier
    • One different attribute that is the DocBook component identifier

Update an existing attribute to add the Identifier property

If you want to add the Identifier property to an attribute that already exists, you can update the attribute to add the property.

Rules for component identifiers:

  • There must be only one attribute that is the DITA component identifier
  • There must be only one different attribute that is the DocBook component identifier

To update an existing attribute to add the Identifier property:

  1. On the Attribute Management tab, select the attribute you want to update.
  2. At the end of the attribute's row, click Update.

    Result: The Update attribute screen opens.

  3. Select Identifier.

    Important:

    • It is not possible for an attribute to be both a component identifier and a language identifier.
    • If you select the Identifier option, there must be no other attribute that already has this property.
    • If you select the Identifier option, you cannot also select the Language option.
    • For more information, refer to: Why do I need an attribute that is a component identifier?
  4. To save your changes, click Update.
    Results:
    • Administrators can see the updated attribute on the Attribute Management tab in the list of attributes.
    • Administrators can select the attribute from the lists on the XML Link Type Configuration screens.
    • Inspire adds the Identifier to all elements in a component.
    You can repeat these steps so that you have:
    • One attribute that is the DITA component identifier
    • One different attribute that is the DocBook component identifier