Site Footer Display Settings (footer)
Controls the rendering of the footer element for site pages. By default, every page is rendered with a footer element that includes information about when the page was last updated and links to the last update and where a reader can submit edits for the page.
Last Edited On Button Link (last_edited_on)
These settings control the “last edited on” button Platen adds to the footer of every page. The button links to
the source control web page for the last commit to the current page. You can disable this link by setting
enabled to false.
JSON Schema
Definition
{
"description": "Controls the button linking to the last change for the current page.\n\nhttps://platen.io/modules/platen/config/site/display/footer/",
"properties": {
"enabled": {
"default": true,
"description": "Choose whether to enable the button link.\n\nhttps://platen.io/modules/platen/config/site/display/footer/#enabled",
"title": "Enable Button Link",
"type": "boolean"
},
"prefix_icon": {
"description": "Controls the prefix icon for the button link.\n\nhttps://platen.io/modules/platen/config/site/display/footer/#prefix_icon",
"properties": {
"library": {
"description": "The library the icon is in.\n\nhttps://platen.io/modules/platen/config/site/display/footer/#library",
"oneOf": [
{
"enum": [
"builtin_bootstrap",
"boxicons",
"font_awesome",
"heroicons",
"iconoir",
"ionicons",
"jam_icons",
"lucide",
"material_icons",
"remix_icon",
"tabler_icons",
"unicons"
]
},
{
"type": "string"
}
],
"title": "Icon Library"
},
"name": {
"default": "calendar-fill@builtin_bootstrap",
"description": "Specify the name of the icon to use.\n\nhttps://platen.io/modules/platen/config/site/display/footer/#name",
"title": "Icon Name",
"type": "string"
},
"variant": {
"description": "The icon variant.\n\nhttps://platen.io/modules/platen/config/site/display/footer/#variant",
"title": "Icon Variant",
"type": "string"
}
},
"required": [
"name"
],
"title": "Prefix Icon",
"type": "object"
},
"use_legacy": {
"default": true,
"description": "Choose whether to use the legacy link.\n\nhttps://platen.io/modules/platen/config/site/display/footer/#use_legacy",
"title": "Use Legacy Link",
"type": "boolean"
},
"variant": {
"default": "text",
"description": "Choose the variant for the button link.\n\nhttps://platen.io/modules/platen/config/site/display/footer/#variant",
"enum": [
"default",
"primary",
"success",
"neutral",
"warning",
"danger",
"text"
],
"title": "Button Variant",
"type": "string"
}
},
"title": "Last Edited On Button Link",
"type": "object"
}Enable Button Link (enabled)
Use this setting to choose whether the button link should display in the page’s footer. When you set this
value to true, the button link is added to the footer. When you set this value to false, the button
link is ignored during the page render.
Prefix Icon (prefix_icon)
Use these options to control the icon used for the button link. By default, Platen displays a calendar icon for the last edited on button link.
JSON Schema
Definition
{
"description": "Controls the prefix icon for the button link.\n\nhttps://platen.io/modules/platen/config/site/display/footer/",
"properties": {
"library": {
"description": "The library the icon is in.\n\nhttps://platen.io/modules/platen/config/site/display/footer/#library",
"oneOf": [
{
"enum": [
"builtin_bootstrap",
"boxicons",
"font_awesome",
"heroicons",
"iconoir",
"ionicons",
"jam_icons",
"lucide",
"material_icons",
"remix_icon",
"tabler_icons",
"unicons"
]
},
{
"type": "string"
}
],
"title": "Icon Library"
},
"name": {
"default": "calendar-fill@builtin_bootstrap",
"description": "Specify the name of the icon to use.\n\nhttps://platen.io/modules/platen/config/site/display/footer/#name",
"title": "Icon Name",
"type": "string"
},
"variant": {
"description": "The icon variant.\n\nhttps://platen.io/modules/platen/config/site/display/footer/#variant",
"title": "Icon Variant",
"type": "string"
}
},
"required": [
"name"
],
"title": "Prefix Icon",
"type": "object"
}Required Properties
Icon Name (name)
Specify the name of the icon to use for the button link. You can use the shorthand syntax for this
value instead of specifying values for the library and variant options.
The shorthand syntax for icons in Platen is <name>[&<variant>][@<library>], where:
<name>is mandatory and represents the name of the icon.&<variant>is optional and represents the variant of the icon. Not all icons and libraries support variants. When you specify a variant in this syntax, you must specify it after the icon’s name. You must separate the variant from the icon name with an ampersand (&). When you don’t specify a variant, Platen uses the library’s default variant.&<library>is optional and represents the library the icon belongs to. When you specify a library in this syntax, you must specify it after the icon’s name and variant. You must separate the library from the icon name or variant with an at sign (@). When you don’t specify a library, Platen uses the configured default library.
Icon Library (library)
This setting specifies the library to load the icon from. You can use any of the registered icon
libraries. If you don’t specify a value for this setting, Platen uses the
features.shoelace.icons.default_library setting’s value as the library.
Don’t specify this setting if you’re including the library in the name setting with the shorthand
syntax.
Icon Variant (variant)
This setting specifies the icon’s variant. Not all icons and libraries have variants. If this value isn’t set, the icon uses its default variant.
Don’t specify this setting if you’re including the variant in the name setting with the shorthand
syntax.
Button Variant (variant)
Choose the variant for the button link. This controls how the button looks on the site.
Use Legacy Link (use_legacy)
Use this setting to choose whether to use the legacy implementation for the “last edited on” footer link.
The current default value is true, which renders the old SVG icon and fixed link text, and ignores all
other settings for the control.
In the future, the default value will change to false. Later, this setting will be removed and only the
new implementation will be available. We strongly recommend you update this setting to false and adjust
your site’s theme as needed.
Edit This Page Button Link (edit_this_page)
These settings control the “edit this page” button Platen adds to the footer of every page. The button links
to the source control web page for editing the current page. You can disable this link by setting enabled to
false.
JSON Schema
Definition
{
"description": "Controls the button linking to where a user can submit edits for the current page.\n\nhttps://platen.io/modules/platen/config/site/display/footer/",
"properties": {
"enabled": {
"default": true,
"description": "Choose whether to enable the button link.\n\nhttps://platen.io/modules/platen/config/site/display/footer/#enabled",
"title": "Enable Button Link",
"type": "boolean"
},
"prefix_icon": {
"description": "Controls the prefix icon for the button link.\n\nhttps://platen.io/modules/platen/config/site/display/footer/#prefix_icon",
"properties": {
"library": {
"description": "The library the icon is in.\n\nhttps://platen.io/modules/platen/config/site/display/footer/#library",
"oneOf": [
{
"enum": [
"builtin_bootstrap",
"boxicons",
"font_awesome",
"heroicons",
"iconoir",
"ionicons",
"jam_icons",
"lucide",
"material_icons",
"remix_icon",
"tabler_icons",
"unicons"
]
},
{
"type": "string"
}
],
"title": "Icon Library"
},
"name": {
"default": "calendar-fill@builtin_bootstrap",
"description": "Specify the name of the icon to use.\n\nhttps://platen.io/modules/platen/config/site/display/footer/#name",
"title": "Icon Name",
"type": "string"
},
"variant": {
"description": "The icon variant.\n\nhttps://platen.io/modules/platen/config/site/display/footer/#variant",
"title": "Icon Variant",
"type": "string"
}
},
"required": [
"name"
],
"title": "Prefix Icon",
"type": "object"
},
"show_elapsed": {
"default": true,
"description": "Choose whether to display the elapsed time since or date of last change to the page.\n\nhttps://platen.io/modules/platen/config/site/display/footer/#show_elapsed",
"title": "Show Elapsed Time",
"type": "boolean"
},
"use_legacy": {
"default": true,
"description": "Choose whether to use the legacy link or the configurable Shoelace button link.\n\nhttps://platen.io/modules/platen/config/site/display/footer/#use_legacy",
"title": "Use Legacy Link",
"type": "boolean"
},
"variant": {
"default": "text",
"description": "Choose the variant for the button link.\n\nhttps://platen.io/modules/platen/config/site/display/footer/#variant",
"enum": [
"default",
"primary",
"success",
"neutral",
"warning",
"danger",
"text"
],
"title": "Button Variant",
"type": "string"
}
},
"title": "Edit This Page Button Link",
"type": "object"
}Enable Button Link (enabled)
Use this setting to choose whether the button link should display in the page’s footer. When you set this
value to true, the button link is added to the footer. When you set this value to false, the button
link is ignored during the page render.
Prefix Icon (prefix_icon)
Use these options to control the icon used for the button link. By default, Platen displays a pencil icon for the edit this page button link.
JSON Schema
Definition
{
"description": "Controls the prefix icon for the button link.\n\nhttps://platen.io/modules/platen/config/site/display/footer/",
"properties": {
"library": {
"description": "The library the icon is in.\n\nhttps://platen.io/modules/platen/config/site/display/footer/#library",
"oneOf": [
{
"enum": [
"builtin_bootstrap",
"boxicons",
"font_awesome",
"heroicons",
"iconoir",
"ionicons",
"jam_icons",
"lucide",
"material_icons",
"remix_icon",
"tabler_icons",
"unicons"
]
},
{
"type": "string"
}
],
"title": "Icon Library"
},
"name": {
"default": "calendar-fill@builtin_bootstrap",
"description": "Specify the name of the icon to use.\n\nhttps://platen.io/modules/platen/config/site/display/footer/#name",
"title": "Icon Name",
"type": "string"
},
"variant": {
"description": "The icon variant.\n\nhttps://platen.io/modules/platen/config/site/display/footer/#variant",
"title": "Icon Variant",
"type": "string"
}
},
"required": [
"name"
],
"title": "Prefix Icon",
"type": "object"
}Required Properties
Icon Name (name)
Specify the name of the icon to use for the button link. You can use the shorthand syntax for this
value instead of specifying values for the library and variant options.
The shorthand syntax for icons in Platen is <name>[&<variant>][@<library>], where:
<name>is mandatory and represents the name of the icon.&<variant>is optional and represents the variant of the icon. Not all icons and libraries support variants. When you specify a variant in this syntax, you must specify it after the icon’s name. You must separate the variant from the icon name with an ampersand (&). When you don’t specify a variant, Platen uses the library’s default variant.&<library>is optional and represents the library the icon belongs to. When you specify a library in this syntax, you must specify it after the icon’s name and variant. You must separate the library from the icon name or variant with an at sign (@). When you don’t specify a library, Platen uses the configured default library.
Icon Library (library)
This setting specifies the library to load the icon from. You can use any of the registered icon
libraries. If you don’t specify a value for this setting, Platen uses the
features.shoelace.icons.default_library setting’s value as the library.
Don’t specify this setting if you’re including the library in the name setting with the shorthand
syntax.
Icon Variant (variant)
This setting specifies the icon’s variant. Not all icons and libraries have variants. If this value isn’t set, the icon uses its default variant.
Don’t specify this setting if you’re including the variant in the name setting with the shorthand
syntax.
Button Variant (variant)
Choose the variant for the button link. This controls how the button looks on the site.
Show Elapsed Time (show_elapsed)
Blah.
Use Legacy Link (use_legacy)
Use this setting to choose whether to use the legacy implementation for the “edit this page” footer link.
The current default value is true, which renders the old SVG icon and fixed link text, and ignores all
other settings for the control.
In the future, the default value will change to false. Later, this setting will be removed and only the
new implementation will be available. We strongly recommend you update this setting to false and adjust
your site’s theme as needed.