Update an attribute

You can update attributes to redefine properties of elements. Attributes provide more information about XML elements and configure component relationships in the system.

You must have Administrator permissions to work with attributes.

Tips and tricks

Rules for component and language 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.
  • There must be only one attribute that is the DITA language identifier.
    • Inspire provides one for DITA (<xml:lang>).
    • If you want to create your own language identifier attribute for DITA, you must update the default attribute to clear the Language option.
  • It is not possible for an attribute to be both a language identifier and a component identifier at the same time.

To update an attribute:

  1. From the Administration menu, select Advanced Settings, and then Attribute Management.
  2. On the Attribute Management tab, select the attribute you want to update.
  3. At the end of the attribute's row, click Update.

    Result: The Update attribute screen opens.

    After an attribute is created, you cannot change the Name. You can create a friendly Display Name or delete the attribute.

  4. 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
  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.

    For more information, refer to: Why would I want an attribute to be profiled?

  7. If you want the attribute to be used to tag content with the schema standard you are using, 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?
  8. If you want the attribute to hold a language code that is used to tag content, select Language.

    Important:

    • It is not possible for an attribute to be both a language identifier and a component identifier.
    • If you select the Language option, there must be no other attribute that already has this property.
    • If you select the Language option, you cannot also select the Identifier option.
    • For more information, refer to: Why do I need an attribute that is a language identifier?
  9. If you want to prevent an author from updating or deleting this attribute in the Oxygen editor, select Protected.

    For more information, refer to: Why would I want to protect an attribute?

  10. To create the attribute, 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.
    • 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.
    • If you selected the Protected option:
      • In the Oxygen editor, to delete or update protected attributes, users must have one of the following permissions:
        • Permissions to the can_modify_protected_attributes property
        • Administrator
      • This protection is enforced in the Oxygen editor in the following places:
        • Author mode

        • Edit XML Source mode

        • Reviews
        • Resolving review