Login
Home CMS Documentation Home CMS 10 Authoring Basics Completing Page and Component Elements Components

Components

A component is an instance of predefined content. Components are used if one piece of content is needed across a site. Embedding a component creates a local copy of its content. Sites usually have several component types. Often, these component types are specific to the site design. In general, a component is a piece of content that is always viewed in the context of a page and is used in multiple places across the site.

Select

Use filtering options to locate your desired component(s). For locating components in the Select a Component dialog, filtering options include:

OptionDescription
Component Type FilterLocated in the upper left, this drop-down list displays all component types. Selecting a single type restricts the component list to only those of the selected component type.
Component Name FilterLocated in the upper right, this field restricts the component list to only those whose names contain the typed text.
Component ListLocated in the upper middle, the search results display potential components. If you type a letter in the field, the list jumps to components whose names begin with the typed letter.
To link a Site Tree component to a Component element:
  1. Navigate to Site > Site Tree.
  2. Select a checked-out item containing a Component element. Ensure the Edit tab is selected.
  3. Expand the Component element.

    Component Element

  4. Choose one of the following steps:
    • Select the components via the Select a Component dialog.
      1. Click Select. The Select a Component dialog displays.
      2. Filter for the desired component, if necessary.
        Note
        Reference the filtering table in the description above.
      3. Preview the values for the selected component. The preview area in the lower half of the Select a Component dialog displays the selected component's content. This makes it easier to verify that the selected component is the one you want.
      4. Click Select.
    • Drag the desired component from the Site Tree to the Component field in the Component element.
  5. Click Save.
    Note
    To link the Site Control component, see Linking Site Control to the Component Element.

Go To

Go To takes you to the linked component in the Site Tree. Use the web browser's back arrow button to return to the page with the Component element.
To go to the Component element's linked Site Tree component:
  • Expand the Component element. Ensure a Site Tree component is linked.
  • Click Go To. The linked Site Tree component displays in the Site pane and is selected in the Site Tree.

Embed

Embed embeds the linked component in the Site Tree to your Component element. Embed provides the option to edit the linked component content within the Component element. If Embed is clicked, options to Unembed and Share display. Unembedding the component reverts the component to its orginal reference. Share allows you to preserve component changes made within the Component element. For new changes made within the Component element, use Share to sync changes to the original component reference or create a different component with your changes. After using the Share option, the component is no longer embedded.

Warning
If the linked component is unembedded, then changes made to the component within the Component element are lost. Use Share to preserve changes.
Note
If a component is created within Share, then the Component element references the new component.

To embed a component:

  1. Expand the Component element. Ensure a Site Tree component is linked.
  2. Click Embed. The linked component is embedded and editable within the Component element.
  3. Click Save and Refresh in the Edit toolbar.
To revert component changes to the original version:
  1. Click Unembed. A warning message displays.
    Warning
    If you Proceed to unembed, changes made to the component within the Component element are lost.
  2. Click Proceed to unembed.
To add changes within the Component element to a new Site Tree component:
  1. Expand the Component element. Ensure the Site Tree component is linked and embedded.
  2. Click Share. The Component Sharing dialog displays.
  3. Click Create New.
  4. Enter the desired parent folder, page, or component for your new component. Click Select.
  5. Refresh the new component's parent. The new component displays as descendant with the same name as the original component and a new xID.
  6. Rename the new component to differentiate from the original version.
To sync changes within the Component element to the original version:
  1. Ensure the linked Site Tree component is checked out.
  2. Expand the Component element. Ensure the Site Tree component is linked and embedded.
  3. Click Share. The Component Sharing dialog displays.
  4. Click Update Original. Changes made within the Component element are synced to the linked component's original version.
    Note
    If the linked Site Tree component is not checked out and assigned to you, then an error message displays. Check out the component and repeat these steps to sync changes.