DocsObject referenceEdit on GitHub

Header Footer Item

One header/footer zone. Fields may be combined when the renderer supports it; otherwise renderers should prefer image, then text-like generated content.

Metadata

Definition

#/$defs/HeaderFooterItem

Type

object

Source

spec/schemas/opf.schema.json

Fields

Field	Type	Req	Description
text	string	—	Literal text rendered in this zone.
image	ref:Asset	—	Generic image rendered in this zone, such as a logo, partner mark, certification badge, or icon.
slideNumber	boolean	—	Whether to render the current slide number in this zone.
date	boolean \| string	—	Whether to render the presentation date, or a literal date string to render.
organization	boolean	—	Whether to render the primary organization name from organization.
section	boolean	—	Whether to render the current slide section label.

text

Type: string · Optional · Default: —

Literal text rendered in this zone.

text.json

{
  "text": "Confidential"
}

image

Type: ref:Asset · Optional · Default: —

Generic image rendered in this zone, such as a logo, partner mark, certification badge, or icon.

image.json

{
  "image": "asset:acme-logo"
}

slideNumber

Type: boolean · Optional · Default: —

Whether to render the current slide number in this zone.

slideNumber.json

{
  "slideNumber": true
}

date

Type: boolean | string · Optional · Default: —

Whether to render the presentation date, or a literal date string to render.

date.json

{
  "date": "date-value"
}

organization

Type: boolean · Optional · Default: —

Whether to render the primary organization name from organization.

organization.json

{
  "organization": true
}

section

Type: boolean · Optional · Default: —

Whether to render the current slide section label.

section.json

{
  "section": true
}