HTML Collection Renderer Settings

Use

The HTML collection renderer allows you to display any folder content (files, folders, and links) in the style of a Web site. For example, you can display files as hyperlinks with any text you choose instead of the file names, and you can include image files directly in the explorer view.

Prerequisites

You have thought about how the HTML collection renderer is to depict a folder as a Web site.

Features

The HTML collection renderer is a static collection renderer that only renders the resources (files, folders, and links) that are entered into an HTML file. You specify this HTML file in the configuration of the HTML collection renderer.

Parameters of the HTML Collection Renderer Settings Group

Parameter	Description
HTML Filename (rndHtmlFilename)	Specifies an HTML file that contains rendering information. You can store the file (for example, meeting.html) in the folder that uses this HTML Collection Renderer. In this case, the specification in the input field is meeting.html. You can also store the file in another folder (for example, /documents/html). The specification in the input field is then /documents/html/meeting.html.

Parameter

Description

HTML Filename (rndHtmlFilename)

Specifies an HTML file that contains rendering information.

You can store the file (for example, meeting.html) in the folder that uses this HTML Collection Renderer. In this case, the specification in the input field is meeting.html.

You can also store the file in another folder (for example, /documents/html). The specification in the input field is then /documents/html/meeting.html.

For information on the other parameters, see the Collection Renderer Settings .

Functionality and Structure of the HTML File

The system searches the specified HTML file for the determined start tag (<a href="http://com.sap.cm/ and <img src="http://com.sap.cm/) and then generates the desired display according to the information found.

Note

As well as tags for hyperlinks and images, which are analyzed by CM, you can also use other HTML functions such as tables.

Structure of Hyperlinks

You have to structure hyperlinks for resources as follows so that they can be analyzed by CM:

<a href="internal system URL + relative path and resource name + modifier">linktext</a>

Note

You can only use one modifier in a hyperlink.

Structural Elements of Hyperlinks

Hyperlink Element	Required	Description
<a href="http://com.sap.cm/	Yes	Start tag of the hyperlink and specification of the URL that the system interprets internally.
./ or ../ or ../folder/	Yes	Relative path to the resource. ./ The resource to be displayed as a hyperlink is located in the folder that the HTML collection renderer is to display. ../ The resource to be displayed as a hyperlink is located in the folder hierarchy one hierarchy level higher than the folder that the HTML collection renderer is to display. `../folder/` The resource to be displayed as a hyperlink is located in the folder specified. Complex combinations of these specifications are possible.
filename.txt or foldername or linkname	No	Name of the resource (for example, file or folder name).
?uicommand=name	No	Modifier that stores the text link with a command .
?uicommand_with_label=name	No	Modifier that displays the name of the command as the link text. If you use this modifier, no self-defined link text is displayed.
?property=propertyID	No	Modifier that displays a property of the files (using the corresponding property renderer) in its original format (for example, as text or as a graphic). See: Predefined Properties
?property=name&asString=true	No	Displays the property in text form (string).
">Linktext</a>	Yes	Link text and end tag of the hyperlink.

For example:

<a href="http://com.sap.cm/./Meeting.doc">Our meeting document</a>

Use the line below to display the name of the current folder:

Use the line below to display the name of the superordinate folder:

Structure of Tags for Displaying Images

You have to structure tags as follows so that image files can be displayed:

Structural Elements of Tags for Displaying Images

Hyperlink Element	Required	Description
<img src="http://com.sap.cm/	Yes	Start tag and specification of the URL that the system interprets internally.
./ or ../ or ../folder/	Yes	Relative path to the image file. ./ The image to be embedded is located in the folder that the HTML collection renderer is to display. ../ The image to be embedded is located in the folder hierarchy one hierarchy level higher than the folder that the HTML collection renderer is to display. `../folder/` The image to be embedded is located in any folder in KM. Complex combinations of these specifications are possible.
filename.gif	Yes	Name of the image file.
">	Yes	End tag.

For example:

Activities

To configure an HTML collection renderer, choose Content Management → User Interface → Settings → Collection Renderer Settings → HTML Collection Renderer Settings.

Example

The Project folder is to be displayed using an HTML collection renderer. The following files are stored in the folder:

Meeting.doc
Members.jpg

When users open the folder, the link text Our meeting document and the description of the document need to be displayed rather than the file name, Meeting.doc. The image needs to be displayed beneath with a size of 320 x 240 pixels.

You create an HTML file and store it with the name meeting.html in the Projectfolder.

<html>

<head>

<title>Meetings</title>

</head>

<body>

<a href="http://com.sap.cm/./Meeting.doc">Our meeting document</a>

<br>

<br>

</body>

</html>

You create an HTML collection renderer (my_HTML_Collection_Renderer). You configure the collection renderer and make the following settings:
HTML Filename = meeting.html
You create a layout set (my_LayoutSet). You configure the layout profile and make the following settings:
Collection Renderer = my_HTML_Collection_Renderer
You create a layout profile . You configure the layout profile and make the following settings:
Layout Set = my_LayoutSet
You assign the layout profile to the folder.