Using Metadata to Display an Associated Content List

IMPORTANT: Starting from release 8.6, this functionality was replaced by the FrameworkUI: <ektron:ContentView> templated server control. If you are already using this functionality, you can continue to do so, but Ektron recommends using current versions of functionality.

You can use the ContentList server control to display a list of content associated with a given content item. First, you define a content list in the metadata of a content block. Then, assign the ID of the content block to the ContentID property and specify a Metadata definition in the MetaTag property. The ContentList server control pulls information defined in the metadata of the content to display the list of content.

The following steps show how to use the DefaultContentID and MetaTag properties to create a content list.

1. In the Workarea, choose Settings > Configuration > Metadata Definition.
2. Click Add Metadata Definition.
3. Enter a title for the data in the Name field. This name is used in the MetaTag property for the server control.
4. Fill in all standard fields. The Type must be Content Selector.
   

   

5. Click Save.
6. Add the definition to all appropriate folders.
   1. Right click a folder and choose View Properties.
   2. Click Edit Properties.
   3. Click the Metadata tab and check the boxes next to the metadata definition. (You may have to break inheritance.)
   4. Click Update.
      
7. For each content item to which you want to associate related content, access its Metadata tab and identify the related item(s). For example, a list of content blocks associated with motorcycle helmets. You want this list to appear whenever a helmet is being viewed. To set this up, you would
   1. Edit the content block.
   2. Click its Metadata tab.
   3. Find the metadata definition for the Content List.
   4. Click Edit.
      

      

   5. Select content for the list and click Insert to display them below.
      

      

8. Optionally reorder the list, then click Save.
9. On a Web form in Visual Studio, add the ContentList server control.
10. Set the DefaultContentID property to the content block’s ID.
11. Add the name of the Metadata field in the Workarea to the MetaTag property.
    

    

12. Set other properties using ContentList.
13. When the Web form is saved, navigate to the page. The content list appears.
    

    

Using the ContentID Property to Display a Content List

1. On a Web form in Visual Studio, insert the ContentList server control.
2. Add a comma-delimited list of content IDs to the ContentIds property.
   

   

3. Set the other properties as you require.
4. Save the Web form, and navigate to the page. The content list appears.
   

   

Retrieving the XML Structure of a ContentList

Retrieving the XML structure of content allows for greater control over developing XSLs. The following example shows how to retrieve the XML structure.

1. Open a new Web form.
2. Drag and drop a ContentList server control onto it.
3. Add at least one content ID to the ContentID property.
4. Drag and drop a textbox on the Web form.
5. Set the TextMode property to MultiLine.

   NOTE: Set the text box width to at least 400 px.

6. On the code-behind page, add the following line.

   Textbox1.Text = ContentList1.XmlDoc.InnerXml

7. Build the project.
8. View the Web form in a browser. The XML structure of the ContentList appears in the textbox.

Displaying Content Reviews on the Site

1. Drag and drop a ContentReview server control on a Web form.
2. Set the DefaultContentID property to the ID of the content whose reviews will be displayed. To make the reviews for the content item dynamic, leave DefaultContentID blank and set DynamicParameter to ID.
3. Set the DisplayXSLT property to Review List. If you want to change the look and feel of the review list, modify an existing XSL file or create your own. If you modify an existing XSL, save the modified file with a different name. Then, enter the file path in the DisplayXSLT property.
4. Set the GetReviews property to Content.
5. Save the form.
   

   

Displaying a User Review on the Site

1. Drag and drop a ContentReview server control on a Web form.
2. Set the DisplayXSLT property to Review List. If you want to change the look and feel of the review list, modify an existing XSL file or create your own. If you modify an existing XSL, save the modified file with a different name. Then, enter the path to the file in the DisplayXSLT property.
3. Set the GetReviews property to User.
4. Set the UserID property to the ID of the user for whom reviews will be displayed. To make the list of reviews for a user dynamic, leave the UserID blank and set the DynamicParameter to ID.
5. Save the form.