Reference a Document Manager element

 

+

Search Tips   |   Advanced Search

 

The Document Manager element tag is used to reference a Document Manager element within a presentation template or component design. It is also used to reference the content of Document Manager documents in a personalization element design.

<DocumentManagerElement type=" " 
                        context=" " 
                        name=" " 
                        key=" " 
                        scope=" " 
                        attributename=" " 
                        format=" " 
                        convertTo=" " 
                        start=" " 
                        end=" " /> 

<DocumentManagerElement	Opens the tag.
type=" "	This determines where the element is being referenced from. Either "content", "sitearea", "site" or "personalization". Referencing Document Manager content using a Personalization rule or content spot. If you use a Personalization Component tag to reference Document Manager content displayed in a Personalization rule or content spot, you will only be able to retrieve attributes about the document. To display the document itself we will need to use a Document Manager element tag with type="personalization".
context=" "	This determines which item is being referenced. Selected Refers to a particular item as specified in the name attribute below. Current This will reference the component from the current site, site area or content file that is being browsed by the user. AutoFill Component being referenced will be determined by the search parameters of a menu, navigator or taxonomy component.
name=" "	Enter the name and library of the item the element is being referenced from. For example, name="library/item". To use the library specified in the URL of the current page, use name="./item". The "name" parameter is not used if context=current or context=autofill.
key=" "	This is the name of the element being referenced from the site, site area or content item. This is not required if type="personalization".
scope=" "	The scope specifies what will be returned from the selected Document Manager document: document This will display the content of the Document Manager document. documenturl This will display the URL to the Document Manager document. attribute This will display a particular attribute of the Document Manager document.
attributeName=" "	If scope="attribute" use this parameter to specify the attribute to display.
format=" "	Used to specify the display format of dates and numbers.
convertTo=" "	Used to specify a mime type that the document should be converted to. For example, "text.html" or "application/pdf".
start=" " end=" "	The start and end attributes are used to wrap the data returned by an IWWCM tag within other tags, such as HTML. These attributes are not mandatory.
/>	Closes a Web Content Management tag.

In previous versions of Web Content Management, this tag was named "DocumentManagerCmpnt". We can still use this tag name, but it will be converted to "DocumentManagerElement" when saved.

 

Examples:

 

Display the attributes of a Document Manager document:

To display the "title" of a Document Manager document, the following tag could be used:

<DocumentManagerElement type="content" context="current" key="component_name" scope="Attribute" attributeName="title" />

To display the "last modified" date of a Document Manager document, the following tag could be used:

<DocumentManagerElement type="content" context="current" key="component_name" scope="Attribute" attributeName="lastModified" format="dd/MM/yyyy" />

 

Display the content of a Document Manager document:

To display the content of a Document Manager document, the following tag could be used:

<DocumentManagerElement type="content" context="current" key="component_name" scope="Document" />

Depending on the content type being returned, we may also need to convert the content to HTML. In this case you would use the following tag:

<DocumentManagerElement type="content" context="current" key="component_name" scope="Document" convertTo="text.html" />

 

Display the URL of a Document Manager document:

To display the URL of a Document Manager document, the following tag could be used:

<DocumentManagerElement type="content" context="current" key="component_name" scope="DocumentURL" convertTo="text.html" />

 

Display the URL of a Document Manager document as a link:

To display the URL of a Document Manager document as a link in a web page, the following tags could be used:

<a href=" <DocumentManagerElement type="content" context="current" key="component_name" scope="DocumentURL" convertTo="text.html" /> "> <DocumentManagerElement type="content" context="current" key="component_name" scope="Attribute" attributeName="title" /> </a>

 

Use a Document Manager component tag in a Personalization component design:

If you use a Personalization component tag to reference Document Manager content displayed in a Personalization rule or content spot, you will only be able to retrieve attributes about the document. To display the document itself use a Document Manager component tag with type="personalization".

<DocumentManagerElement type="personalization" context="autofill" scope="document" convertTo="text.html" />

 

Parent Topic

Present documents in Web content

 

Parent Topic

Reference elements

 

---