Update elements

As an Inspire administrator, you can add elements to configure component relationships. When updating elements, you can set properties to specify if an element needs an ID, is a root or document element, and the schema standard that must be used when validating the element.

When you specify if an element needs an ID, you need to determine if it also needs a root Id.

Root ID Elements that are not roots
Each XML document has exactly one root element. Use this option when creating an element that is a topic type. This option is used for an element that contains text, an attribute, other elements, an entity reference, or a processing instruction.
By default, Inspire provides the following root elements: By default, Inspire provides the following elements that are not roots:
Needs Id = Yes, and Root Id = Yes Needs Id = Yes, and Root Id = No
  • bookmap
  • concept
  • glossentry
  • glossgroup
  • learningAssessment
  • learningContent
  • learningOverview
  • learningPlan
  • learningSummary
  • map
  • reference
  • subjectScheme
  • task
  • topic
  • troubleshooting
  • body
  • conbody
  • fig
  • fn
  • hazardstatement
  • image
  • li
  • note
  • refbody
  • row
  • section
  • step
  • substep
  • table
  • taskbody

To update an element:

  1. From the Administration menu, select Advanced Settings, then Element Management.
  2. On the Element Management tab, select the element that you want to update and click Update pencil_icon.
  3. On the Update Element screen, you can modify the Name using 100 characters.

    An element name must follow these rules:

    • Names are case sensitive.
    • Must start with a letter or underscore.
    • Cannot start with the letters xml, XML, Xml, or any variation of these letters.
    • Contains any of the following: letters, digits, hyphens, underscores, and periods.
    • Cannot contain spaces.
  4. If you want to force the Oxygen editor to create an ID for this element, select Needs Id.

    When the user clicks Save and Submit or Generate IDs, an ID is assigned to the all instances of the element.

    If you do not select Needs Id, when the user clicks Save and Submit or Generate IDs, an ID is NOT assigned to any instances of the element. The user can manually add an attribute type of ID if necessary.

  5. If you selected Needs Id, do one of the following for Root Id:
    • If the element is the parent for all other elements, like the Concept element, select Root Id.
    • If the element is not a root node, like an image, leave Root Id unselected.
  6. In Skip Id, if an ID for is not supported for this element in the DTD, select this option.

    By default, this option is not selected. If you select Skip Id for this element:

    • When content is imported, no ID is generated.
    • In the Oxygen editor, no ID is generated when the Generate IDs or Save and Submit options are used.
    • This behavior is enforced even if the automaticIds option is turned on.
  7. In Schema Standard, select the schema version that must be used to validate the element. For example, DITA_1.3.
  8. To save your changes to the element, click Update.

    Results:

    • You are returned to the Element Management screen.
    • Users must log out and back in to see the changes in the Oxygen editor