Section Front Matter (section)
Defines optional settings for the Toroidal module on a section (_index.md) page using values
in the page’s front matter.
This is largely only useful for defining defaults for the webring through Hugo’s cascade
feature, allowing you to define the values once at the section level and override or extend
them for members as needed.
JSON Schema
Definition
{
"$id": "https://platen.io/schemas/toroidal/content/section/schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Optional settings for the Toroidal module on a section page.\n\nhttps://platen.io/schemas/toroidal/content/section/",
"properties": {
"cascade": {
"description": "Values in this setting are applied by default to pages in this section.\n\nhttps://platen.io/schemas/toroidal/content/section/#cascade",
"properties": {
"toroidal_class": {
"default": "",
"description": "Specifies one or more classes to append to the generated HTML for the webring\n\nhttps://platen.io/schemas/toroidal/content/section/#toroidal_class",
"title": "Additional Class",
"type": "string"
},
"toroidal_hide_header": {
"default": false,
"description": "Specifies whether to hide the h2 header on member pages in this webring\n\nhttps://platen.io/schemas/toroidal/content/section/#toroidal_hide_header",
"title": "Hide Header on Member Pages",
"type": "boolean"
},
"toroidal_random_member_link": {
"default": true,
"description": "Whether the navigation for a member should include a link to a random member\n\nhttps://platen.io/schemas/toroidal/content/section/#toroidal_random_member_link",
"title": "Display Random Member",
"type": "boolean"
},
"toroidal_webring_name": {
"description": "Specifies the name of the webring\n\nhttps://platen.io/schemas/toroidal/content/section/#toroidal_webring_name",
"title": "Webring Name",
"type": "string"
}
},
"title": "Cascade Options",
"type": "object"
}
},
"title": "Section Front Matter",
"type": "object"
}Cascade Options (cascade)
Specifies values to apply to pages in this section by default. If a page also defines one of these settings, the value in the page’s frontmatter overrides any set here at the section level. Values for this setting override any set in the site configuration.
Webring Name (toroidal_webring_name)
Specifies the name of the webring. If this value isn’t specified, the default name
Webring is used.
This setting overrides the toroidal.webring_name in the site’s
configuration. You can override this setting on a per-member basis by setting
toroidal_webring_name in the member page’s front matter.
Display Random Member (toroidal_random_member_link)
Specifies whether the navigation for a member should include a link to a random member
of the webring. Set this value to true to enable the random member link and false to
disable it. The default is true.
This setting overrides the toroidal.random_member_link in the site’s
configuration. You can override this setting on a per-member basis by setting
toroidal_random_member_link in the member page’s front matter.
Additional Class (toroidal_class)
Specifies one or more classes to append to the generated HTML for the webring. To specify multiple classes, separate each class with a space. You can use this value with the defined themes to style a webring more specifically.
This setting overrides the toroidal.class in the site’s configuration. You
can override this setting on a per-member basis by setting toroidal_class
in the member page’s front matter.
Hide Header on Member Pages (toroidal_hide_header)
This setting specifies whether to hide the h2 element on member pages. By default,
every member page includes the webring’s name as an h2 at the top of the member’s
navigation. Set this value to true to hide the element on member pages for this
webring.
This setting overrides the toroidal.hide_header in the site’s
configuration. You can override this setting on a per-member basis by setting
toroidal_hide_header in the member page’s front matter.