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 

 (tick)

Server, Data Center

 

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

Scaffolding

 (error)

Server, Data Center

  • true - the only accepted value

 

Type

 (error)

Server, Data Center

  • line - the only acceptable value

 

Content

 (error)

Server, Data Center

  • 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

 (error)

Server, Data Center

 

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

 (error)

Server, Data Center

 

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

Maximum Length

 (error)

Server, Data Center

 

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

Pattern

 (error)

Server, Data Center

 

The regular expression the text must match.

Pattern Info (Pattern Error Message)

 (error)

Server, Data Center

 

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

Width

 (error)

Server, Data Center

 

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

Only applicable for forms mode.

Height

 (error)

Server, Data Center

 

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

Only applicable for forms mode.

Tutorial Examples