Overview

The qCaptionDisplay is a web part that displays a message from a SharePoint list. The text for the message is identified with a Caption ID.

Storing the message in a list, as opposed to hard coding it in a page, increases the site maintainability. This is useful if the site is replicated. If you need to make a change to the message, you only have to do it in one place; just change the list. The list usually resides outside of the replicated site.

You can localize the title and the messages displayed by the caption display. You can define different Title for different cultures using the Resource List and the Title Resource ID properties. The culture for the page can be defined by appending the Culture HTTP parameter to the page URL. For example:

http://hostname/sites/sitename/default.aspx?Culture=en-US

To use the caption display, you must first define a source list for the captions. The SharePoint list for the caption display should contain these fields:

•	Caption ID — This field is mandatory. It is a single-line text field that contains the identifier for the caption.

•	Caption — This field is mandatory. This is a multiple-line text field that contains the message.

•	Culture — This field is optional. You must have this field if you want to have different messages for a different culture. You can define different captions with the same Caption ID, but different Culture. You must leave the value for the default culture blank. For example:

 

Table 1. Culture

Caption ID	Culture	Caption
sites.mysite.default.aspx		Welcome to my site
sites.mysite.default.aspx	id-ID	Selamat datang ke situs saya

NOTE: Make sure that the Allow rich HTML text in the Caption field is set to No.

If your list uses different name for the fields, define the name in the Caption ID Field Name, Caption Field Name and Culture Field Name properties.

NOTE: The Caption field can contain plain text or a piece HTML.

You can create the source by selecting Dell Caption Display List (under Custom Lists in SharePoint). This automatically creates a list that contains all of the above fields.

Define a convention for the Caption ID value that makes it easy for you to identify where the message is used. For example, use the URL of the page, remove the host name from the URL and replace all / with . (period). Therefore, if the page URL is http://hostname/sites/mysite/default.aspx, the Caption ID is sites.mysite.default.aspx.