Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

The Text Data macro allows editing of free text data.

Parameters

Name

Required

Migratable to Cloud?

Default Value

Description

Field Name

 Yes

No


The name of the text data field.

 Must

Info

The name must be unique.

Type

 Optional

No

  • area

 -
    • if macro is created with Rich Text Editor

  • line

 -
    • if macro is created with wiki markup

The type of field.

Info

Applies to plain text content only.

May be one of the following:

  • area

 - A
    • a multi-line text area field

  • line

 - A
    • a single-line text area field

  • password

 - A
    • a single-line password field

Note:
Info

Only applicable for forms mode.

Content Type

 Optional

No

  • richtext

 -
    • if macro is created with Rich Text Editor

  • wiki

 -
    • if macro is created with wiki markup

The type of content in the field.

May be one of the following:

  • richtext

  • text

  • noformat

  • quote

  • code

  • wiki

Info
Note: 

To input field within text-data of richtext or quote type, click on the field to initiate a richtext editor. Only applicable for forms mode.

Required

 Optional

No

false

If 

If true

 the

 the field cannot be empty. 

Language

 Optional

No


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

 This

Info

This is only used when the Content Type is set to code.

e.g.: 

For example

  • "content=code:JavaScript"

Whatever languages are
  • 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. 

(Version 5

Status
colourBlue
titlev5.2.0 and above only

.)

Image Removed
Image Added

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 may use regular expressions with this parameter.

Consult this 

Image Added

Info

Consult this Knowledge Base article

 on

 on the use of regular expressions with Scaffolding.

Image Removed

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 

chooses Save.

Image Removed
Image Added

Width

 Optional

No


The width of the text field.

Set as either

  • pixels (e.g. "250px"

or
  • )

  • percentage (e.g."100%"

.
  • )

Info

Only applicable for forms mode.

Height

 Optional

No


The height of the text field.

Set as either

  • pixels (e.g. "250px"

or
  • )

  • percentage (e.g."100%"

.
  • )

Info

Only applicable for forms mode.

Editor View

...

Notes

Warningnote

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

Image Modified

Tutorial Examples

Filter by label (Content by label)
showLabelsfalse
showSpacefalse
cqllabel = "text-data" and space = currentSpace ( )
labelstext-data