Text Data

Text Data

Overview

The Text Data macro allows editing of free text data.

Parameters

Name

Required

Migratable to Cloud?

Default Value

Description

Name

Required

Migratable to Cloud?

Default Value

Description

Field Name

 Yes

No



The name of the text data field.

The name must be unique.

Type

 Optional

No

  • area - if the macro is created with the Rich Text Editor.

  • line - if the macro is created with wiki markup.

The type of field.

Applies to plain text content only.

Can be:

  • area - a multi-line text area field

  • line - a single-line text area field

  • password - a single-line password field

Only applicable for forms mode.

Content Type

 Optional

No

  • rich text - if the macro is created with the Rich Text Editor.

  • wiki - if the macro is created with wiki markup.

The type of content in the field.

Can be:

  • richtext

  • text

  • noformat

  • quote

  • code

  • wiki

To input a field within a Text Data with Content Type set to richtext or quote, click the field to initiate a rich text editor. This is only applicable to forms mode.

Required

 Optional

No

false

If true the field cannot be empty. 

Language

 Optional

No



The programming language to use for formatting the content is Java or XML.

This is only used when the Content Type is set to code. For example, content=code:JavaScript.

Any language that is valid for the {code} macro can be used.

 

Hide Full Text

 Optional

No

false

Clip text and display a Show more button if the text is more than one line. v5.2.0 and later only

Minimum Length

 Optional

No



If specified, the text must be at least this many characters long.

Maximum Length

 Optional

No



If specified, the text must be at most this many characters long.

Pattern

 Optional

No



Specify the text that the content in the Text Data macro must match.

You can use regular expressions with this parameter.

Consult this Knowledge Base article on the use of regular expressions with Scaffolding.

Pattern Error Message

 Optional

No



If the Pattern parameter is specified, this is displayed if the saved value does not match when the user clicks Save.

Width

 Optional

No



The width of the text field.

Can be in one of the following formats:

  • pixels (e.g. 250px)

  • percentage (e.g. 100%)

Only applicable for forms mode.

Height

 Optional

No



The height of the text field.

Can be in one of the following formats:

  • pixels (e.g. 250px)

  • percentage (e.g. 100%)

Only applicable for forms mode.

Editor View

Notes

Links to other pages inside a Text Data may break when the linked page is moved to another space. Clicking the broken link (pictured below) will prompt the user to create a new page.

Page link

Tutorial Examples