Member Front Matter (member)
Defines settings for a Toroidal webring member using values in the page’s front matter. Any settings defined for a member page always overwrite settings defined for the site and webring.
JSON Schema
Definition
{
"$id": "https://platen.io/modules/toroidal/config/content/member/schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Optional settings for the Toroidal module on a content page.\n\nhttps://platen.io/modules/toroidal/config/content/member/",
"properties": {
"description": "map[description:Specifies a short description of the member site. schematize:map[details:Specifies a short description of the member site. This value is used as the synopsis\nfor the member in the member list and in the the metadata for the member's iframe page.\n weight:%!s(int=2)] title:Member Description type:string]\n\nhttps://platen.io/modules/toroidal/config/content/member/#properties",
"name": {
"description": "Specifies the display name of the member site.\n\nhttps://platen.io/modules/toroidal/config/content/member/#name",
"title": "Member Display Name",
"type": "string"
},
"toroidal_class": {
"default": "",
"description": "Specifies one or more classes to append to the generated HTML for the webring\n\nhttps://platen.io/modules/toroidal/config/content/member/#toroidal_class",
"title": "Additional Class",
"type": "string"
},
"toroidal_hide_header": {
"default": false,
"description": "Specifies whether to hide the h2 header on this member page\n\nhttps://platen.io/modules/toroidal/config/content/member/#toroidal_hide_header",
"title": "Hide Header on Member Pages",
"type": "boolean"
},
"toroidal_home_page": {
"description": "The URL to the webring member's home page.\n\nhttps://platen.io/modules/toroidal/config/content/member/#toroidal_home_page",
"title": "Member HomePage",
"type": "string"
},
"toroidal_member_name": {
"description": "Specifies the name of the member\n\nhttps://platen.io/modules/toroidal/config/content/member/#toroidal_member_name",
"title": "Member Name",
"type": "string"
},
"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/modules/toroidal/config/content/member/#toroidal_random_member_link",
"title": "Display Random Member",
"type": "boolean"
},
"toroidal_webring_name": {
"description": "Specifies the name of the webring\n\nhttps://platen.io/modules/toroidal/config/content/member/#toroidal_webring_name",
"title": "Webring Name",
"type": "string"
},
"weight": {
"description": "Specifies the member's position in the webring.\n\nhttps://platen.io/modules/toroidal/config/content/member/#weight",
"minimum": 0,
"title": "Weight",
"type": "integer"
}
},
"required": [
"name",
"description",
"weight",
"toroidal_home_page"
],
"title": "Member Front Matter",
"type": "object"
}Required Properties
Member Display Name (name)
Specifies the display name of the member site. This value is used in the member list, the title for the member’s iframe page, and the webring’s administration page.
Member Description (description)
Specifies a short description of the member site. This value is used as the synopsis for the member in the member list and in the the metadata for the member’s iframe page.
Weight (weight)
Specifies the member’s position in the webring. This value is used to determine the order to display the member in the member list and the webring’s administration page. It’s also used to determine which members of the webring are adjacent, ensuring a deterministic and validly looping webring.
Member HomePage (toroidal_home_page)
The URL to the webring member’s home page. If this value isn’t specified for a member, Hugo raises an error.
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 both toroidal.random_member_link in the site’s
configuration and toroidal_random_member_link in the webring’s section page
front matter, if set.
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 both toroidal.class in the site’s configuration and
toroidal_class in the webring’s section page front matter, if set.
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 both toroidal.webring_name in the site’s configuration
and toroidal_webring_name in the webring’s section page front matter, if set.
Member Name (toroidal_member_name)
Specifies the name of the member. This setting overrides the value used in
name. Use this when you want the page name and the member name to be
different.
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 the page.
This setting overrides both toroidal.hide_header in the site’s configuration
and toroidal_hide_header in the webring’s section page front matter, if set.