Excerpt Data

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

NameRequiredAvailable InMigratable to Cloud?Default ValueDescription
Name 
 Yes
Server, Data Center
No
The name of the excerpt data field. Must be unique.
Scaffolding
 Optional
Server, Data Center
No
  • true - the only accepted value
Type
 Optional
Server, Data Center
No
  • line - the only acceptable value
Content
 Optional
Server, Data Center
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
 Optional
Server, Data Center
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
 Optional
Server, Data Center
No
If specified, the text must be at least this many characters long.
Maximum Length
 Optional
Server, Data Center
No
If specified, the text must be at most this many characters long.
Pattern
 Optional
Server, Data Center
No
The regular expression the text must match.
Pattern Info (Pattern Error Message)
 Optional
Server, Data Center
No
If the pattern is specified, this is displayed if the saved value does not match it.
Width
 Optional
Server, Data Center
No

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

Only applicable for forms mode.

Height
 Optional
Server, Data Center
No

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

Only applicable for forms mode.


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.22.4 and above, this feature is now available again after bug fixes from Confluence. Hence, it is advisable to upgrade your Confluence to version 7.8.0 and above.

Tutorial Examples