Webring Section Front Matter

Optional settings for the Toroidal module on a section page.
Validating Schema
https://json-schema.org/draft/2020-12/schema
Schema ID
https://toroidal.platen.io/schemas/config/content/section.json
Type
object

Description #

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.

Settings #

Cascade Options (cascade) #

Option Name
cascade
Type
object
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) #

Option Name
toroidal_webring_name
Type
string

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.

Option Name
toroidal_random_member_link
Type
boolean

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 Classes (toroidal_class) #

Option Name
toroidal_class
Type
string

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) #

Option Name
toroidal_hide_header
Type
boolean

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.