Skip to main content

Content Keywords

Seven keywords for the substance of a document — text, callouts, quotations, citations, code, images, and links.

text:

Category: Content Since: v1.0 Aliases: note:, body:, content:, paragraph:, p:

General body text — the default block type.

Syntax

text: content | style-properties

Examples

text: The project is on track for a June delivery.
text: Total contract value: USD 24,000 | weight: bold
text: Please review by end of week | color: #dc2626 | italic: true

Notes

  • Supports all style properties
  • Supports inline formatting: *bold*, _italic_, ~strike~, ```code```, ^highlight^, `label`, {Label}
  • note: is the most common alias — both text: and note: work identically

info:

Category: Content Since: v1.0

Callout block. Renders with a colored background and visual indicator.

Syntax

info: content | type: variant

Properties

PropertyTypeDescription
typestringCallout variant: info (default), warning, danger, tip, success

Examples

info: This document uses IntentText v2.14 format.
info: This contract expires in 14 days. Renewal required. | type: warning
info: Deleting this record is irreversible. | type: danger
info: Use intenttext query to find all deadlines across your folder. | type: tip
info: Migration completed — 12,450 records transferred. | type: success

Callout aliases

The variant forms warning:, danger:, tip:, and success: are aliases for info: with the type: property set automatically:

AliasEquivalentVisual style
warning:info: ... | type: warningAmber / yellow
danger:info: ... | type: dangerRed
tip:info: ... | type: tipGreen / blue
success:info: ... | type: successGreen
// These are equivalent:
info: This contract expires in 14 days. | type: warning
warning: This contract expires in 14 days.

The parser resolves both forms to { type: "info", properties: { type: "warning" } }. There is no behavioral difference.


quote:

Category: Content Since: v1.0 Aliases: blockquote:, excerpt:, pullquote:

Block quotation with optional attribution.

Syntax

quote: content | citation: source

Properties

PropertyTypeDescription
citationstringAttribution text

Examples

quote: The best way to predict the future is to invent it. | citation: Alan Kay
quote: All documents should be machine-readable from birth. | citation: IntentText Manifesto

cite:

Category: Content Since: v1.0 Aliases: citation:, source:, reference:

Bibliographic citation with author, date, and URL.

Syntax

cite: title | author: name | date: year | url: link

Properties

PropertyTypeDescription
authorstringAuthor name(s)
datestringPublication date or year
urlstringLink to the source

Examples

cite: The Pragmatic Programmer | author: Hunt, Thomas | date: 2019
cite: Structured Documents in Enterprise | author: Chen, Wei | date: 2025 | url: https://arxiv.org/example

code:

Category: Content Since: v1.0 Aliases: snippet:

Code block with optional language for syntax highlighting.

Syntax

Single-line code — wrap the value in triple backticks:

code: ```content``` | lang: language

Multi-line code — open with triple backticks, close on a separate line:

code: ```
line 1
line 2
``` | lang: language

Properties

PropertyTypeDescription
langstringProgramming language for highlighting

Examples

code: ```const doc = parseIntentText(source);``` | lang: typescript
code: ```
SELECT *
FROM users
WHERE active = true
``` | lang: sql

Inline code

To include code inline within any text block, use triple backticks:

text: Call the ```render()``` function to generate output.
text: Set ```NODE_ENV=production``` before deploying.

Notes

  • Properties (| lang: js, etc.) go after the closing ```, like any other pipe property
  • Plain code: content (without backtick wrapper) still works for simple one-liners

image:

Category: Content Since: v1.0

Inline image. No caption, no number — flows with surrounding text.

Syntax

image: alt text | src: url | width: value

Properties

PropertyTypeRequiredDescription
srcstringyesImage URL or path
widthstringnoDisplay width

Examples

image: Company logo | src: ./images/logo.png | width: 200px
image: Architecture diagram | src: ./diagrams/arch.png

Notes

  • For numbered, captioned figures use x-writer: figure instead
  • image: is inline; x-writer: figure is a formal numbered element

Category: Content Since: v1.0

Hyperlink to an external resource.

Syntax

link: display text | url: target | title: tooltip

Properties

PropertyTypeRequiredDescription
urlstringyesLink target
titlestringnoTooltip text

Examples

link: IntentText Hub | url: https://intenttext-hub.vercel.app
link: View the full contract | url: ./contracts/acme-2026.it | title: Acme Services Contract

Extension keywords

Editorial and document cross-reference blocks are available as extension keywords.

x-writer: — Editorial / Publishing

ExtensionPurpose
x-writer: bylineAuthor name and publication date
x-writer: figureNumbered, captioned figure
x-writer: captionFigure or table caption
x-writer: footnoteNumbered footnote with inline reference
x-writer: epigraphIntroductory quotation
x-writer: dedicationDocument dedication

x-doc: — Document Cross-References

ExtensionPurpose
x-doc: defTerm definition / glossary entry
x-doc: contactPerson or organization contact information
x-doc: deadlineDate-bound milestone
x-doc: refCross-document reference with relationship
x-doc: signlineSignature line for print documents

See Extension Keywords → for full syntax documentation.