Create an attribute

You can add attributes to provide more information about XML elements and configure component relationships in the system.

You must have Administrator permissions to manage attributes.

Tips and tricks

Understanding attribute identifiers. When you're creating an attribute, you can configure it to be one of the following types:

  • A component Identifier. This type of attribute holds a string of numbers and characters to uniquely identify a component. By default the ID is created based on the schema standards and uses one of the following formats:
    • DITA: id
    • Docbook: xml:id
  • A Language identifier. This type of attribute holds a language code in the form of xml:lang.

You can use these options to identify if an attribute is a component identifier and a language identifier. Keep the following rules in mind:

  • It is not possible for an attribute to be a component identifier and a language identifier.
  • It is not possible for multiple attributes to be component identifiers.
  • It is not possible for multiple attributes to be a language identifier.
  • There must be at least one component identifier.
  • Language identifier is not required.

To create an attribute:

  1. From the Administration menu, select Advanced Settings, and then Attribute Management.
  2. On the Attribute Management tab, click Create.

    Result: The Create new attribute screen opens.

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

    This is a system name, so you cannot use spaces or special characters.

  4. Optionally, you can create a similar Display Name that's more user-friendly.
  5. In Schema Standard, select the schema version that must be used to validate the attribute. For example, DITA_1.3.
  6. Optionally, to specify that this attribute can be used to identify conditional text, select Profiled.
  7. If the attribute holds a string of numbers and characters to uniquely identify a component, select Identifier.

    It is not possible for an attribute to be both a component identifier and a language identifier.

  8. If the attribute holds a language code in the form of xml:lang, select Language.

    It is not possible for an attribute to be both a component identifier and a language identifier.

  9. 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.
    • Users can select this attribute in the Oxygen editor in the Attributes pane on the right side.
    • If you selected the Profiled option, then users can select the attribute from the lists on the Profiling Attributes screen.