Schema Designer Elements


In general, the elements available vary according to the purpose of the page. For example, an Event Page might contain an event location element, whereas a generic Detail Page would probably not.

Even though the specific elements vary by page type, there are a fixed number of element types. Different element types take different forms of input (e.g. text, image, media). The icon next to an element provides a visual clue about the input needed to complete the element.

The table below provides a list of elements that are currently available for use in the CMS.

Icon Type Description

Text

document24.png

Plain Text

Contains only unformatted text. The Plain Text element is often used for titles, abstracts, captions, or contact information.

XHTML Editor

Contains text that accepts formatting , hyperlinks, images, tables, and more. Typically used for the main body of a page to create formatted content.

Assets

image24.png

Image

Selects an image from the xml\images folder on the server to display on the current page.

media24.png

Media

Selects a media file from the xml\media folder on the server to display on the current page. Typically used to link to media such as a sound or video file.

Document

Links directly to a document from the xml\documents folder on the server. Typically used to link to a PDF or Word document.

Links

Link

Links to either an internal page in the site tree, an external web site, or a document in the xml\documents folder. Typically used to create hyperlinks to other locations.

Link Set

Selects a series of links in a re-orderable list as well as a text title for the set of links. This element generates content in a typical navigation-page node format and supports structured URLs. Content will update automatically when linked pages are checked in.

Functional

Component

Creates a relationship between two nodes in the site tree. This element is a slot into which a chunk of content can be dropped for other pages to use.

Insert

Pulls in content from either an outside source, such as a webpage, or from an internal source. Typically used to pull in content from a webpage outside the site.

Com Execute

Connects to a .dll file such as for a DbQuery, SMTP connector, or SOAP connector. Typically used to retrieve records from external data.

Java Execute

Calls a Java Execute object to import data into a page. Typically, this information originates from a database.

ü ComExecute and JavaExecute Elements are recommended for advanced users.

Password

Encrypts information used by JavaExecute and ComExecute components. Typically used to encrypt a database connection string.

Organizational

group24.png

Group

· Group Start

· Group End

Visually groups elements on the Edit Form tab. Typically used to group elements that are similar in nature, for example, event-related elements like Event Name, Event Date, and Event Location.

group24.png

List

Provides end users the ability to add a variable number of additional subelements. Typically used when the number of desired items is unknown.

Navigation

Navigation

Automatically pulls content from a location in the site tree. Typically used to create navigation lists at the top, left, and/or bottom of pages.

Taxonomy Navigation

Pulls page references based on taxonomical categories applied to pages throughout a site. Unlike standard Navigation elements, Taxonomy Navigation does not rely on the hierarchical structure of the site tree to return values.

References Navigation

Allows a page to reference other content items within the site. Typically used to create cross-references within a site.

Date / Time

Date

Lets users select a date by way of a calendar date-picker interface. Date content is stored as server time with a GMT offset in UTC format.

Local Date

Lets users select a date from a calendar date-picker interface. Local Date content is stored as YYYY-MM-DD and has no offset.

Local Time

Lets users select a time. Local time content is stored as HH:MM:SS and has no offset.

Selection

check24.png

Checkbox

Selects a binary option such as yes/no or on/off. Typically used to turn on or off some function in the site or some chunk of displayed content.

Dropdown

Provides a dropdown list from which a single item can be selected from a predefined list of items. The source for the items in this list can be defined in the schema itself, or can be dynamically generated from nodes within the site tree.

dropdown24.png

Multi-Select

üHard-coded

üDbQuery

üCMS node-set

üExternal Scripting

Lets users select multiple choices from a list. The various versions of the Multi-Select element have the same editing interface, but differ on how the list of choices is assembled. The source for items in this list can be hard-coded in the schema, queried from a database, executed by a custom script, or dynamically generated from nodes in the site tree.

Basic Attributes

Most elements have the following attributes available.

Attribute

Values

Description

Used By

label

SomeText

Words that display above the element in the Edit Form tab.

All elements except when in a List.

readonly

true

false

When true, element is visible, but grayed out and unable to be modified without permission to modify read-only elements.

All elements except Group and List.

hidden

true

false

When true, hidden from groups without permission to view hidden elements.

All elements.

required

true

false

When true, the page cannot be checked in without a value in the element.

All elements except List; has no effect on Navigation, Taxonomy Navigation, Reference, and Checkbox.

Default Value Attributes

Many elements have attributes that you can set to a default value, simplifying user experience by reducing the amount of content to enter. Default values can be overwritten on the Edit Form tab after a page has been created.

 

Element

Attribute

Values

Description

Text

Plain Text

XHTML Editor

default

This is some default text

Sets the default value of the plain text or XHTML editor element.

Assets

Image

Media

Document

default

image1.jpg

media1.mp3

document1.doc

Sets the default image/media/document of the element.

Links

Link

Link

external

document

Type of link (external or document). If no type is specified, the link is internal instead.

URL

www.yoursite.com

document1.doc

The URL of an external link or a document name from the document assets folder.

LinkText

clickable text

The clickable text that will appear as the Link Name.

Target

_blank

_self

_parent

Sets the window in which the link will open.

Link Set

Title

Some LinkSet Title

Sets the title of the Link Set element.

Functional

Component

Component

xID

Presets the element with the xID for a particular component on page creation.

Insert

Insert

www.ingeniux.com

-or-

Sample.xml

Presets the element with a particular insert value, such as http://www.ingeniux.com or Sample.xml. If an internal source, the source document must reside in the \PreBuilt directory on the server.

Navigation

Navigation

Navigation

 

Sets the type of navigation on page creation

GenerationOrder

up

down

Generation order (up/down); only used when navigation attribute is set to Ancestors.

StartPage

xID

Starting page from which navigation results should be returned (xid); acts as a stop page when the navigation attribute is Ancestors.

MaxNodes

number

Maximum number of pages pulled in.

MaxDepth

number

Maximum depth of navigation.

Query

XPath

Optional XPath query that may be used to filter results of a navigation. This runs the query against the full navigation as opposed to running against the page's raw XML, as is done by the multi-select element.

Taxonomy Navigation

StartNodes

xID|xID|xID

Specifies one or more xID from which to start pulling pages that meet the taxonomical criteria. All of the pages below and including the specified StartNode(s) that have been associated with the taxonomy criteria will be pulled into the page.

IncludePages

true

false

When true, XML for the pages is brought back, otherwise only taxonomy categories are returned.

Depth

number

How deep (-1 to 6) into the taxonomy hierarchy to search.

FilterSchemas

SchemaName

Filter out pages by page schema.

FilterParentPages

xID

Filter out pages by parent page.

References Navigation

Depth

number

The depth of the chained references (0 to 7).

QuerySchemas

SchemaName

Filter out choices from a particular schema.

QueryLocationRoots

xID|xID

Specify one or more locations in the site hierarchy from which to pull choices (xid)

IncludeCrossReferences

true

false

Determine if the reference will bring back pages that are referencing it.

Date / Time

Date

Local Date

default

20120824t12:00:00

Sets a default date according to Universal Time (UTC) .

Local Time

default

14:00:55

Sets a default time .

Selection

Checkbox

default

true

false

Sets the default value of the check box to checked when true, unchecked when false.

Dropdown

default

somechoice

Sets the dropdown with a specific value chosen from the set of values created in the element definition.

Multi-Select

default

choice1|choice2

Sets the default selection. Set more than one choice with a pipe-delimited list.

Different elements may have different syntaxes for setting default values. Check Appendix B for examples of each element's attribute syntax.

Updating out-of-sync pages via Schema Designer > Synchronization will not change the default value of an element on an existing page. Default values are only used during page creation.

When you set default values for exports, the tag is split open. The export tag is included within the open and close tags for the element.

Elements that use the default exports attribute include link, navigation, references, and taxonomy navigation.

Expanded Attributes

Some elements can be expanded to show all their contents or collapsed to reveal only the name of the element in the Edit Form tab. For these elements, an attribute of Expanded is available to set the default behavior.

Element Attribute Values Description

Group, Image, Link,

List, Media, Navigation

Expanded

true

false

Determines whether the element is expanded by default.

Other Attributes

In addition to basic attributes and default value attributes, there are a handful of element-specific attributes.

Element

Attribute

Values

Description

Component

Comp

Types

SchemaName1; SchemaName2

Limits the list of components in the component picker dialog to those using a particular schema. Use a semicolon as a delimiter to choose multiple schemas.

Date

display

localdatelong localdatelongtime localdateshort localdateshorttime

Determines the format of the date (1/15/2014 or January 15, 2014), and if the element should display only the date or both the date and time.

Multi-Select

All Multi-Select Elements

PageSize

number

Sets the number of choices listed per page in the choice selection dialog.

MaxChoices

number

Sets the number of options that can be selected from the given choices.

Hard-coded

Values

Choice1|

Choice2|

Choice3|

Choice4|

Choice5

Specifies the list of options from which a user can select choices. The list must be pipe-delimited.

DbQuery

DSN

SomeDSN

Define the data source name (DSN) used to access the specified database.

SQL

"select Column from database"

Define a select statement returning one or more columns from a database.

CMS node-set

Query_PageType

SchemaName

Determines the type of page or component to be included in the result set.

Query_LocationRoot

xID

Determines the location in the site tree from which items should be retrieved.

Query_SelectedFields

@Name

Determines which fields in the items should be returned in the result set. Use a pipe character to add multiple attributes

AdditionalFilter_XPathQuery

XPath

Allows the element to filter results based on an XPath query

Refer to Element Attributes for Schema XML for an alphabetical listing of element types and their respective attributes.