Learning Levels

Announcements

Data Definition Schema Reference

Download data-definition-schema.xsd

group

Tag Name	Parent Element	Description	Req.
group	{group}	Used to group collections of fields together with a border around the contained items. Groups can be nested inside of other groups.	No

Attribute(s)

Attribute Name	Values	Description	Req.
identifier	[alphanumeric]	The name of the resultant XML tag upon outputting the Data Definition	Yes
label	[string]	The text displayed on the screen as the title of the grouping	Yes
required	true, false	Whether or not the group is required for the user to supply data	No
multiple	true, false	Whether or not this group of items can be repeated by the user	No
maximum-number	[numeric]	If multiple is allowed, how many times can this group be repeated.	No
restrict-to-groups	[groups]	A comma separated list of groups that his field is restricted to for access purposes. If the user is not a member of one of the groups, the field does not appear.	No

asset

Tag Name	Parent Element	Description	Req.
asset	{group}	Used to allow the user to choose an existing asset within the CMS.	No

Attribute(s)

Attribute Name	Values	Description	Req.
identifier	[alphanumeric]	The name of the resultant XML tag upon outputting the Data Definition.	Yes
label	[string]	The text displayed on the screen as the label of the asset chooser.	Yes
multiple	true, false	Whether or not the user is allowed to create additional assets.	No
required	true, false	Whether or not this field is required.	No
help-text	[string]	Help information that is specific to the field. This help text pop-up when the user moves their mouse over the label.	No
type	page, file, block, symlink	The type of asset chooser used to filter the available choices.	Yes
render-content-depth	1, unlimited	This determines the depth to render to for structured data pages embedded into each other. If the value is "unlimited" it will set the number of structured data pages that can be embedded into each other to unlimited or more specifically 231 - 1. If the value is set to a number, the number of nested structured data pages is limited to that number. If this attribute is not specified, or an invalid value is present, an unlimited number is assumed.	No
restrict-to-groups	[groups]	A comma separated list of groups that his field is restricted to for access purposes. If the user is not a member of one of the groups, the field does not appear.	No

text

Tag Name	Parent Element	Description	Req.
text	{group}	Used for manual input from the user resulting in a text valued stored for the XML.	No

Attribute(s)

Attribute Name	Values	Description	Req.
identifier	[alphanumeric]	The name of the resultant XML tag upon outputting the Data Definition.	Yes
label	[string]	The text displayed on the screen as the label of the text field.	Yes
multiple	true, false	Whether or not the user is allowed to create additional text fields.	No
default	[string]	The default value of the text field.	No
multi-line	true, false	For text input fields, whether or not it should have multiple input lines.	No
maximum-number	[numeric]	The maximum number of additional fields allowed (only if multiple is also true).	No
regular-expression	[JavaScript regular expression]	A JavaScript regular expression with which to match the data inputted by the user.	No
input-data-format	[string]	The value to display to the user if the regular expression doesn't match.	No
wysiwyg	true, false	Whether or not the text field should be a visual word processor.	No
wysiwyg-toolbar-remove	font formatting, font assignment, text formatting, insert image, insert table, html view	Elements of the wysiwyg that can be removed from the toolbar. (Is only valid when wysiwyg value is true.)	No
rows	[numeric]	Number of rows when multi-line=”true”.	No
cols	[numeric]	Number of columns when multi-line=”true”.	No
maxlength	[numeric]	The maximum number of characters in a standard text field.	No
size	[numeric]	The width of a standard text field.	No
help-text	[string]	Help information that is specific to the field.	No
type	checkbox, dropdown, radiobutton, multi-selector, datetime	The type of text input field. Leave attribute out for a standard text input box. Please note that the value "calendar" is deprecated in favor of "datetime."	Yes
restrict-to-groups	[groups]	A comma separated list of groups that his field is restricted to for access purposes. If the user is not a member of one of the groups, the field does not appear.	No

checkbox-item

Tag Name	Parent Element	Description	Req.
checkbox-item	text	Available items only used with text type of checkbox.	Yes

Attribute(s)

Attribute Name	Values	Description	Req.
value	[string]	The value to be shown on the screen and displayed in the resulting XML.	Yes
checked	true, false	Whether or not this item is currently checked.	No

dropdown-item

Tag Name	Parent Element	Description	Req.
dropdown-item	text	Available items only used with text type of drop down.	Yes

Attribute(s)

Attribute Name	Values	Description	Req.
value	[string]	The value to be shown on the screen and displayed in the resulting XML.	Yes

selector-item

Tag Name	Parent Element	Description	Req.
selector-item	text	Available items only used with text type of multi-selector.	Yes

Attribute(s)

Attribute Name	Values	Description	Req.
value	[string]	The value to be shown on the screen and displayed in the resulting XML.	Yes
selected	true, false	Whether or not this item is currently selected.	No

radio-item

Tag Name	Parent Element	Description	Req.
radio-item	text	Available items only used with text type of radio button.	Yes

Attribute(s)

Attribute Name	Values	Description	Req.
value	[string]	The value to be shown on the screen and displayed in the resulting XML.	Yes