logo of XML Sapiens
XML Sapiens Yahoo Group
Join Now
6.3.3 Attributes
Beginning » XML Sapiens v.1.1 Specification » 6. Body of the SAPI Document » 6.3 Data Containers » 6.3.3 Dynamic Data Container (SAPI:DDC) » 6.3.3.1-.14 Attributes

6.3.3.1 Attribute name

Attributes definition

name = %Text [CN]

Mandatory. The value of this attribute contains a data container name.

This attribute contains the data container name that identifies the object in a SAPI document (see Objects of SAPI Documents). The container content (the data it refers to) can be called using the SAPI:APPLY element.

6.3.3.2 Attribute title

Attributes definition

title = %Text [CI]

Recommended. The value of this attribute contains the data container title that specifies the container in the list.

This attribute should not be ignored. A short but an informal container description will help to avoid errors during site configuration.

6.3.3.3 Attribute category

Attributes definition

category [CI]

Recommended. The value of this attribute specifies the category of the dynamic data container.

This attribute allows cataloguing a container (functional solution) at SAPI Works Gallery, and informs the CMS on the processing peculiarities for this container. A list of available categories for dynamic data containers is provided at Categories of Dynamic Data Containers.

6.3.3.4 Attribute system

Attributes definition

system = %Text [CN]

Deprecated. If an element contains this attribute, its value specifies the CMS system programming language used in the body.

In the body of data containers a direct reference to the programming language code (that governs the parser) is allowed. In some cases this feature may simplify the definition of functional algorithms. However, using a system programming language in a data container body may cause difficulties at functional solutions exchange through SAPI Works Gallery. Users of the CMS handled by a different programming language will not be able to utilize this functional solution.

6.3.3.5 Attribute ns

Attributes definition

ns = %Text [CN]

Optional. The value of this attribute contains a pointer to the namespace assigned to the given data container.

6.3.3.6 Attribute status

Attributes definition

status = %Text [CN]

Optional. If an element contains this attribute, its value specifies the status of the container activity.

This attribute can be either omitted in an element or available with value “hidden”. By default, and in case there is no attribute in the element, the container is processed by the parser. In case attribute “hidden” is provided, the parser ignores the container.

6.3.3.7 Attribute parent-id

Attributes definition

parent-id = %Text [CN]

Optional. Parent section identifier.

The default parent section in a documented CMS structure for an information channel (see Peculiarities of SAPI Information Channels Description) is the section that contains the document with the navigation channel list. This attribute is used to access the specified information channel.

6.3.3.8 Attribute cache

Attributes definition

cache = %Charset [CI]

Optional. The value of this attribute shows to the parser, whether caching of the current document is allowed.

6.3.3.9 Attribute mdate

Attributes definition

mdate = %Datetime [CN]

Optional. This attribute contains the date and time of the latest document modification.

6.3.3.10 Attribute indexdate

Attributes definition

indexdate = %Datetime [CN]

Optional. This attribute contains the name of the query container that corresponds to the date of the information channel node.

This attribute is used to indicate to the CMS administration area interface, the content of which query (query container) should be treated as the date of the information channel node.

6.3.3.11 Attribute indextitle

Attributes definition

indextitle = %Text [CN]

Optional. This attribute contains the name of the query container that corresponds to the title of the information channel node.

This attribute is used to indicate to the CMS administration area interface, the content of which query (query container) should be treated as the title of the information channel node.

6.3.3.12 Attribute indexdesc

Attributes definition

indexdesc = %Text [CN]

Optional. This attribute contains the name of the query container that corresponds to the abstract (summary) of the information channel node.

This attribute is used to indicate to the CMS administration area interface, the content of which query (query container) should be treated as the abstract of the information channel node.

6.3.3.13 Attribute mask

Attributes definition

mask = %Text [CN]

Optional. This attribute contains the mask of access to the content of the information channel element.

This attribute is used to indicate to the CMS administration area interface, which part of the URI specifies parameters of the information channel node content. The mask attribute may contain values in the syntax readable by the CMS parser. For example, the value of attribute "year/month/day/id" may indicate to the parser that the URI may contain parameters for filtering by year, month, day (e.g., http://site/infochannel_url/2004/05/15/2389).

(C) 2004-2006 Red Graphic Systems. All Rights Reserved. Red Graphic Systems liability, trademark, document use and software licensing rules apply. Your interactions with this site are in accordance with our public and Member privacy statements.