Figures & Images

Image Node Specification¶

Image hyperlink

type: string, (“image”)

See also Node

class: string, optional

user-defined class for image

width: string, optional

image width in pixels or percentage

align: string, optional, (“left” | “center” | “right”)

No description for this property.

url: string

See also Resource

title: string, optional

See also Resource

alt: string, optional

See also Alternative

position: object, optional, (Position)

See also Node

data: object, optional

See also Node

Image Node Example¶

Markup

AST

Render

![fishy](fun-fish.png)

type: root
children:
  - type: paragraph
    children:
      - type: image
        url: fun-fish.png
        alt: fishy

Containers¶

Container Node Specification¶

Top-level container node to provide association and numbering to child content

type: string, (“container”)

See also Node

kind: string, (“figure” | “table”)

kind of container contents

class: string, optional

any custom class information

enumerated: boolean, optional

count this container for numbering based on kind, e.g. Figure 1a

enumerator: string, optional

resolved enumerated value for this container

children: array, (Caption | Legend | Image | Table)

See also Parent

identifier: string, optional

See also OptionalAssociation

label: string, optional

See also OptionalAssociation

position: object, optional, (Position)

See also Node

data: object, optional

See also Node

Container Node Example¶

Markup

AST

Render

```{figure} https://via.placeholder.com/150
This is the figure caption!

Something! A legend!?
```

type: root
children:
  - type: mystDirective
    name: figure
    args: https://via.placeholder.com/150
    value: |-
      This is the figure caption!

      Something! A legend!?
    children:
      - type: container
        kind: figure
        children:
          - type: image
            url: https://via.placeholder.com/150
          - type: caption
            children:
              - type: paragraph
                children:
                  - type: text
                    value: This is the figure caption!
          - type: legend
            children:
              - type: paragraph
                children:
                  - type: text
                    value: Something! A legend!?