Create a component in the Components browser

You create a component by selecting a template type (DITA or DocBook) and giving it a name. If necessary, you can change the default folder where it's saved, the default Language, and the default system filename. Optionally, you can create the component as a template or create multiple components at once. After you create an XML component, you can edit it in an Oxygen-based editor.

File name recommendations.

  • If possible, try to avoid using DITA control characters such as square brackets ([]) in the name. This can cause a validation error when you add the topic to a map. For more information, read Creating components.
  • You must use a Component Name of 100 or fewer characters.
  • File names must be 150 or fewer characters.
  • For more information on the different types of names that Inspire uses, read How to name a component.

To create a component:

  1. Click Components_TopMenuOpt Components.
  2. In the Folder pane, select the folder where you want to create a component.
  3. Right-click the folder, and then select Create Component...
    You can access the same menu by clicking Action_Menu the Options menu.

    Results: The Create Component screen opens.

  4. In Target Folder, by default, you see the folder you were in when you selected the option to create a component.

    To change the location where the component will be stored, use the dropdown arrow to select a new folder.

  5. In Available Templates, select what type of content is in this component.

    The template type defines the component's XML structure and which elements can be included.

    • For example, the XML structure differs between a Concept and a Task, because DITA uses different topic shells for each information type.
    • A concept and a task aren’t just stylistic variations; they have different root elements, different allowed children, and different required structures.
  6. In New Component Name, enter a title for the component in 100 or fewer characters.
    You can easily change a component's name after creating it.
  7. In Language, by default, it's set to the English language. To change the default, select the language in which the content is written.
    When you open this component for editing, Inspire loads the spelling dictionary for the language you choose. For example, if you choose the French language, when you're editing this component and turn on spell check, correctly spelled English words will be underlined in red as a warning of a misspelling. French words spelled correctly won't be underlined in red.

    Notes:

    • The language you select is applied to the root level element in the xml:lang attribute.
    • To ensure content that is read from Right-to-Left displays correctly in Oxygen, Inspire may set the Reading property.
      • For the language you choose, if the language Reading property is rtl (Right-to-Left) and it doesn't exist yet, Inspire sets it.
      • For example, <concept id="concept_guid" xml:lang="ar-Ar" dir="rtl">
      • Inspire makes no changes if the language Reading property is ltr (Left-to-Right)
    • If necessary, an administrator can change the language after you create the component.
  8. Optionally, if you want this component to contain a template structure instead of content, select Create as Template.
    Only users with the following permissions can create templates when creating a component:
    • Administrator permissions
    • Access to the Content Browser module, and listed as a user for the can_create_template property.
    • Access to the Content Browser module, and belonging to a role that is listed for the can_create_template property.
    • Even if you don't have permissions to create a template, you can still access a component's Details and add or remove the Template property.
    • If you are an administrator, to grant permissions, refer to Allow users to create a template.
  9. In Number of copies, the default is set to 1. To create multiple components at once with the same settings, use the up and down arrows or enter the number of components you want to create.

    If this number is greater than 1:

    • Inspire creates multiple components of the same type in the same place.
    • Inspire appends a suffix of (1), (2), (3) to the end of each component's New Component Name.
  10. Optionally, you can create a File Name that is different from the Component Name by selecting Override File Name.

    By default, the File Name is the same as the component Name, except with underscores instead of spaces. This makes it easier for Web services, scripts, and plugins to process. Inspire will add a GUID and a file extension to the file name after you click Create.

    1. Edit the File Name using underscores instead of spaces. (File names must be 150 or fewer characters.)

      For more information on the different types of names that Inspire uses, read How to name a component.

  11. On the Create Component screen, click Create.

    Results:

    The screen closes, and you are returned to the Components browser.

    • In the Folders panel, the location you selected in Target Folder is highlighted.
    • In the Components pane, the component you created is selected and highlighted in yellow.

    You do not need to refresh the Components browser to find your new component.