ADF node: text

Node

Description

The text node holds general document text.

The HTML equivalent is any bare text to be displayed, such as would be found inside a paragraph. Except where otherwise noted, text nodes can be augmented with any of several marks to enhance how they are displayed.

Empty text nodes are not permitted; a non-empty text property must be provided.

Implementation Note: In the Java library, most nodes that are frequently used with simple paragraph and text nodes also provide methods that accept String values for convenience. Where these are available, they implicitly wrap the strings in text and paragraph nodes as required.

Example

Java

1
2
p(text("Hello world"));

ADF

1
2
3
4
5
6
7
8
9
10
{
  "type": "paragraph",
  "content": [
    {
      "type": "text",
      "text": "Hello world"
    }
  ]
}

Result

Hello world

Compatibility

Products

Nodes/Usage

• codeBlock – no marks1
• CaptionContent
• InlineContent

Marks

• CodeTextMark2
• FormattedTextMark3

Structure

• type - text
• text - string (not empty)
• marks? - array(CodeTextMark…) | array(FormattedTextMark…)

---

1. Although text nodes are usually permitted to have marks, these are not permitted inside a codeBlock.↩︎
2. The marks for text nodes are classified as CodeTextMarks, FormattedTextMarks, or both. All marks on a single text node have to belong to the same list. For example, code is only a CodeTextMark and em is only a FormattedTextMark, so they cannot be used together. The link is in both lists, so it can be combined with either of them.↩︎
3. The marks for text nodes are classified as CodeTextMarks, FormattedTextMarks, or both. All marks on a single text node have to belong to the same list. For example, code is only a CodeTextMark and em is only a FormattedTextMark, so they cannot be used together. The link is in both lists, so it can be combined with either of them.↩︎