Description

This is a special case of Text Data that stores its value as the page's excerpt, using the Confluence Excerpt macro.

This macro will dynamically add and update the Excerpt macro in a page. This adds convenience by allowing page excerpts to be edited directly through Scaffolding, so that users do not have to edit the actual Confluence page just to update the Excerpt macro.

Parameters

Name

Required

Migratable to Cloud?

Default Value

Description

Name

  • (/)

  • NO

 

The name of the excerpt data field. Must be unique.

Scaffolding

  • (X)

  • NO

  • true - the only accepted value

 

Type

  • (X)

  • NO

  • line - the only acceptable value

 

Content

  • (X)

  • 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

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.

Language

  • (X)

  • NO

 

The programming language to use for formatting the content Java or XML. This is only used when the Content Type is set to code.

e.g.: "content=code:JavaScript"

Whatever languages are valid for the {code} macro can be used.

Minimum Length

  • (X)

  • NO

 

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

Maximum Length

  • (X)

  • NO

 

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

Pattern

  • (X)

  • NO

 

The regular expression the text must match.

Pattern Info (Pattern Error Message)

  • (X)

  • NO

 

If the pattern is specified, this is displayed if the saved value does not match it.

Width

  • (X)

  • NO

 

The width of the text field. e.g. "250px" or "100%".

Only applicable for forms mode.

Height

  • (X)

  • NO

 

The width of the text field. e.g. "250px" or "100%".

Only applicable for forms mode.

Editor View

Not applicable.

Macro Edit View

Not applicable.

Notes

The "Copy with Scaffolding XML" feature is temporarily disabled when Collaborative Editing mode is turned off in earlier versions of Scaffolding, due to a Confluence bug. This bug affects Scaffolding versions from 8.19.11 to 8.22.3.

For Scaffolding version 8.23.2 and above, this feature is now available again after bug fixes from Confluence. Hence, it is advisable to upgrade your Confluence to either:

  • Confluence 7.4 LTS, starting from version 7.4.6 OR

  • Confluence version 7.8.0 and above

However, this feature is not supported for Confluence version 7.5, 7.6, or 7.7.

Tutorial Examples