Creating Structured Authoring Fields

NEWS & TIPS

  • Site Access Keys
  • Top: Alt+t
    Previous: Alt+,
    Next: Alt+.
    Up: Alt+;
    (Note: use Ctrl on the Mac)

Data Definition Schema Reference

Tag

Tag NameParent ElementDescriptionReq.
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 NameValuesDescriptionReq.
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
requiredtrue, false

Whether or not the group is required for the user to supply data

No
multipletrue, 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

Tag

Tag NameParent ElementDescriptionReq.
asset{group}

Used to allow the user to choose an existing asset within the CMS.

No

Attribute(s)

Attribute NameValuesDescriptionReq.
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
multipletrue, false

Whether or not the user is allowed to create additional assets.

No
requiredtrue, 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
typepage, file, block, symlink

The type of asset chooser used to filter the available choices.

Yes
render-content-depth1, 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

Tag

Tag NameParent ElementDescriptionReq.
text{group}

Used for manual input from the user resulting in a text valued stored for the XML.

No

Attribute(s)

Attribute NameValuesDescriptionReq.
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
multipletrue, 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-linetrue, 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
wysiwygtrue, false

Whether or not the text field should be a visual word processor.

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
typecheckbox, 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

Tag

Tag NameParent ElementDescriptionReq.
checkbox-itemtext

Available items only used with text type of checkbox.

Yes

Attribute(s)

Attribute NameValuesDescriptionReq.
value[string]

The value to be shown on the screen and displayed in the resulting XML.

Yes
checkedtrue, false

Whether or not this item is currently checked.

No

Tag

Tag NameParent ElementDescriptionReq.
dropdown-itemtext

Available items only used with text type of drop down.

Yes

Attribute(s)

Attribute NameValuesDescriptionReq.
value[string]

The value to be shown on the screen and displayed in the resulting XML.

Yes

Tag

Tag NameParent ElementDescriptionReq.
selector-itemtext

Available items only used with text type of multi-selector.

Yes

Attribute(s)

Attribute NameValuesDescriptionReq.
value[string]

The value to be shown on the screen and displayed in the resulting XML.

Yes
selectedtrue, false

Whether or not this item is currently selected.

No

Tag

Tag NameParent ElementDescriptionReq.
radio-itemtext

Available items only used with text type of radio button.

Yes

Attribute(s)

Attribute NameValuesDescriptionReq.
value[string]

The value to be shown on the screen and displayed in the resulting XML.

Yes

Last modified on Mon, 05 Nov 2007 11:06:04 -0500

Topic Feedback Form

Content Rating:
Email:
Feedback:


Top / Next / Up / Table of Contents