What is metadata?
Metadata describes pages, folders, and the entire website to instruct the front-end to deliver the experience and performance that editorial teams design. Metadata allows editorial teams to store information, for example, to control SEO performance or connect the website to social media.
Metadata values can be set at the root level. All subfolders and pages inherit those root values, but editors can overwrite them for each folder and page. When overwritten in a folder, all subfolders and pages under that folder inherit metadata values from the parent folder.
Metadata vs variables
Metadata and variables share the same inheritance behavior. However, they fill different purposes:
Metadata is a design tool that editorial teams use to describe pages, folders, and the entire website.
Variables are a development tool that front-end developers define and use when building the website. Variables make pages dynamic and, so, reusable. Unlike metadata, variables don't necessarily have an editorial meaning, but a technical purpose while building the website.
Where do I find the Metadata definition page?
In the left menu, the fifth item links to the Metadata definition page:
Select it to display the Metadata definition page:
How do I define metadata?
The Page Builder comes without pre-defined metadata to fit any bespoke editorial need.
Let's refer to the most common metadata, SEO data.
Select the
button: 
In the Add new category page, add the section's name:
Then, select the
button or paste your JSON definition of the SEO metadata.
When selecting the
button, you get an empty JSON to fill with the SEO metadata fields.
A valid JSON sample
A valid section's metadata JSON in an object.
There's no constraint about fields because metadata is a contract by convention between the Page Builder website definition and the front-end implementation.
For example, the SEO metadata JSON may look like the following:
{
"displayName": "SEO settings",
"pageBuilderVisible": true,
"properties": {
"description": {
"displayName": "Website description",
"type": "string"
},
"image": {
"displayName": "Website image",
"type": "string"
},
"robots": {
"displayName": "The robots.txt path",
"type": "string"
},
"sitemaps": {
"displayName": "The site map",
"type": "string"
},
"siteName": {
"displayName": "The site name",
"type": "string"
},
"title": {
"displayName": "The site title",
"type": "string"
}
},
"type": "object"
}How do I use metadata?
You can value the SEO metadata defined above when editing folders and pages, in the Metadata tab:
Each metadata field can have a different value for different languages. For example, the Website Description field:
Use cases
SEO
The SEO metadata describes the website for SEO performance purposes:
{
"type": "object",
"displayName": "SEO settings",
"pageBuilderVisible": true,
"properties": {
"site_name": {
"type": "string",
"displayName": "Site Name"
},
"title": {
"type": "string",
"displayName": "Page Title"
},
"description": {
"type": "string",
"displayName": "Page Description"
},
"image": {
"type": "string",
"displayName": "Page Image"
},
"robots": {
"type": "string",
"displayName": "Robots"
},
"canonical_url": {
"type": "string",
"displayName": "Canonical URL"
}
}
}Social
The Social metadata describes the website connection to social media:
{
"type": "object",
"displayName": "Socials settings",
"pageBuilderVisible": true,
"properties": {
"twitter_id": {
"type": "string",
"displayName": "Twitter Id"
},
"fb_pages": {
"type": "string",
"displayName": "Facebook Pages"
},
"fb_app_id": {
"type": "string",
"displayName": "Facebook App Id"
}
}
}Theming
The Theming metadata describes the website's theme and skinning:
{
"type": "object",
"displayName": "Theming settings",
"pageBuilderVisible": true,
"properties": {
"color_schema": {
"type": "string",
"displayName": "colour schema mode",
"enum": [
"light",
"dark"
]
},
"primary_on_light": {
"type": "string",
"displayName": "colour brand primary on light mode"
},
"primary_50_on_light": {
"type": "string",
"displayName": "colour brand primary variant 50 on light mode"
},
"primary_100_on_light": {
"type": "string",
"displayName": "colour brand primary variant 100 on light mode"
},
"primary_200_on_light": {
"type": "string",
"displayName": "colour brand primary variant 200 on light mode"
},
"primary_300_on_light": {
"type": "string",
"displayName": "colour brand primary variant 300 on light mode"
},
"primary_on_dark": {
"type": "string",
"displayName": "colour brand primary on dark mode"
},
"primary_50_on_dark": {
"type": "string",
"displayName": "colour brand primary variant 50 on dark mode"
},
"primary_100_on_dark": {
"type": "string",
"displayName": "colour brand primary variant 100 on dark mode"
},
"primary_200_on_dark": {
"type": "string",
"displayName": "colour brand primary variant 200 on dark mode"
},
"primary_300_on_dark": {
"type": "string",
"displayName": "colour brand primary variant 300 on dark mode"
},
"secondary_on_light": {
"type": "string",
"displayName": "colour brand secondary on light mode"
},
"secondary_50_on_light": {
"type": "string",
"displayName": "colour brand secondary variant 50 on light mode"
},
"secondary_100_on_light": {
"type": "string",
"displayName": "colour brand secondary variant 100 on light mode"
},
"secondary_200_on_light": {
"type": "string",
"displayName": "colour brand secondary variant 200 on light mode"
},
"secondary_300_on_light": {
"type": "string",
"displayName": "colour brand secondary variant 300 on light mode"
},
"secondary_on_dark": {
"type": "string",
"displayName": "colour brand secondary on dark mode"
},
"secondary_50_on_dark": {
"type": "string",
"displayName": "colour brand secondary variant 50 on dark mode"
},
"secondary_100_on_dark": {
"type": "string",
"displayName": "colour brand secondary variant 100 on dark mode"
},
"secondary_200_on_dark": {
"type": "string",
"displayName": "colour brand secondary variant 200 on dark mode"
},
"secondary_300_on_dark": {
"type": "string",
"displayName": "colour brand secondary variant 300 on dark mode"
}
}
}Sitemap
The Sitemap metadata describes the website sections:
{
"type": "object",
"displayName": "Sitemaps settings",
"pageBuilderVisible": true,
"properties": {
"blacklist": {
"displayName": "Blacklist to excluded pattern (pipe separated)",
"type": "string"
},
"sitemap_article_entity_code": {
"displayName": "Sitemap Article Entity Code",
"type": "string"
},
"sitemap_article_schema": {
"displayName": "Sitemap Article Schema",
"type": "string"
},
"sitemap_video_entity_code": {
"displayName": "Sitemap Video Entity Code",
"type": "string"
},
"sitemap_video_schema": {
"displayName": "Sitemap Video Schema",
"type": "string"
}
}
}Languages
The Languages metadata describes the language the website supports:
{
"type": "object",
"displayName": "Languages settings",
"pageBuilderVisible": true,
"properties": {
"en_us_culture": {
"type": "string",
"displayName": "en-US - Culture"
},
"en_us_voc_tag": {
"type": "string",
"displayName": "en-US - Vocabulary tag"
},
"en_us_url": {
"type": "string",
"displayName": "en-US - URL"
},
"fr_fr_culture": {
"type": "string",
"displayName": "fr-FR - Culture"
},
"en_gb_voc_tag": {
"type": "string",
"displayName": "fr-FR - Vocabulary tag"
},
"en_gb_url": {
"type": "string",
"displayName": "fr-FR - URL"
}
}
}