Toroidal Site Configuration (config)

JSON Schema

{
  "$id": "https://platen.io/modules/toroidal/config/site/config/schema.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Settings and options for the Toroidal module at the site level.\n\nhttps://platen.io/modules/toroidal/config/site/config/",
  "properties": {
    "admin_details": {
      "default": "default",
      "description": "Specifies the partial to use for the \"About Member Administration\" details\n\nhttps://platen.io/modules/toroidal/config/site/config/#admin_details",
      "oneOf": [
        {
          "enum": [
            "default",
            "none"
          ]
        },
        {
          "type": "string"
        }
      ],
      "title": "Administration Details"
    },
    "class": {
      "default": "",
      "description": "Specifies one or more classes to append to the generated HTML for webrings\n\nhttps://platen.io/modules/toroidal/config/site/config/#class",
      "title": "Additional Class",
      "type": "string"
    },
    "hide_header": {
      "default": false,
      "description": "Specifies whether to hide the h2 element on member pages\n\nhttps://platen.io/modules/toroidal/config/site/config/#hide_header",
      "title": "Hide Header on Member Pages",
      "type": "boolean"
    },
    "mode": {
      "default": "auto",
      "description": "Specifies whether the Toroidal pages on the site should display in light or dark mode or use the site visitor's OS preference setting.\n\nhttps://platen.io/modules/toroidal/config/site/config/#mode",
      "enum": [
        "auto",
        "light",
        "dark"
      ],
      "title": "Display Mode",
      "type": "string"
    },
    "random_member_link": {
      "default": true,
      "description": "Specifies whether to include a link to a random member in the ring navigation\n\nhttps://platen.io/modules/toroidal/config/site/config/#random_member_link",
      "title": "Random Member Link",
      "type": "boolean"
    },
    "themes": {
      "$ref": "https://platen.io/modules/toroidal/config/site/themes/schema.json"
    },
    "webring_name": {
      "description": "Specifies the name of the webring to host\n\nhttps://platen.io/modules/toroidal/config/site/config/#webring_name",
      "title": "Webring Name",
      "type": "string"
    }
  },
  "title": "Toroidal Site Configuration",
  "type": "object"
}

Webring Name (webring_name)

If this value is specified, it’s used as the default name for webrings on the site. This value is most useful if you’re creating your webring in the content/toroidal folder and don’t want to add an _index.md file.

If you’re hosting multiple webrings on the same site, every webring except one will need to define a section page (_index.md) and override this value with toroidal_webring_name in the front matter.

This value can also be overridden on a per member basis with toroidal_webring_name in the member page’s front matter.

Random Member Link (random_member_link)

This value specifies whether the generated navigation for webring members should include a link to a random member of the webring. If this value is set to false, the link isn’t included. If this value is set to true, the link is included. The default is true.

The implementation of the random member link ensures visitors of member sites not using an iframe for their webring navigation to visit a random member of the webring, even when connectivity to the webring host isn’t available. In that case, the navigation uses a pre-defined list of available members from when the member site’s administrator copied the HTML snippet.

When there’s connectivity to the webring host, the random member link instead calls the host’s API for the most up-to-date list of members and randomly selects one.

This value can be overridden at the webring level by defining toroidal_random_member_link in the front matter of the webring’s section (_index.md) page. It can also be overridden on a per member basis with toroidal_random_member_link in the member page’s front matter.

This value only affects the inclusion of the link in member navigation, not the availability of the API for the webring.

Display Mode (mode)

Specifies whether the Toroidal pages on the site should display in light mode (light), dark mode (dark), or the mode that matches the site visitor’s OS preferences (auto).

This setting only has an effect if the module is used without the Platen module or when the toroidal.enabled feature for Platen is set to false.

This setting only affects the member pages and their iframes, not the rest of the site.

The default is auto.

Toroidal Theme Style Modules (themes)

The Toroidal module includes a minimal default set of styles. Each item in this setting is a key-value pair. The key represents the name of the style and the value determines whether and how it’s loaded into the style for Toroidal pages. When you import the module, only the default theme is defined. You can define additional key-value pairs and override the settings for default.

If the value is set to true, the downcased name of the theme is used when importing the theme’s style module. If the value is set to false, the theme’s style module isn’t imported. If the value is set to a string, it’s used as the name of the theme’s style module.

For example:

themes:
  default: true  # imports `assets/toroidal/themes/_default.scss`
  unused: false  # not imported
  custom: fooBar # imports `assets/toroidal/themes/_fooBar.scss`

Defining Style Modules #

You can override the default style module or define entirely new ones. When you define a new style module, consider whether you want to extend the styling for all Toroidal content or only a subset webring.

You can use article.toroidal to style content in the administration page and nav.toroidal to style the member page content. You can add another class to the selector, like nav.toroidal .my-example to target only a subset of content. You can inject classes into your generated content with the toroidal.class setting in the site configuration or the toroidal_class setting in a page’s front matter.

For more information, see Toroidal Theme Style Modules

Additional Class (class)

Specifies one or more classes to append to the generated HTML for webrings. 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 value can be overridden at the webring level by defining toroidal_class in the front matter of the webring’s section (_index.md) page. It can also be overridden on a per member basis with toroidal_class in the member page’s front matter.

Hide Header on Member Pages (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 site. You can override this setting on a per-webring basis by setting toroidal_hide_header in the webring’s section page front matter or by setting toroidal_hide_header in the member page’s front matter.

Administration Details (admin_details)

This setting defines the partial to use for the “About Member Administration” details element in a webring’s administration page. It defaults to default. You can set it to none to intentionally exclude the details.

The pre-defined options are:

• default - Defined in layouts/partials/toroidal/adminDetails/default.md
• none - Defined in layouts/partials/toroidal/adminDetails/none.md
• platen - Defined in layouts/partials/toroidal/adminDetails/platen.md

On Platen sites, when the default details would be used, platen is used instead to account for the differences between a Toroidal webring on a Platen site.

Defining and Overriding Details #

You can override the pre-defined options by creating a file of the same name and path in your own site or module. You can also define entirely new options, as long as your partial is valid.

The partial must return valid HTML or an empty string. If it returns an empty string, the details element isn’t rendered.

The partial gets the page context for the webring administration page as input.

By default, this partial assumes that the specified details partial is a markdown file unless the name ends with a file extension. It also assumes that the partial is in layouts/partials/toroidal/adminDetails unless it has a path prefix, like myWebring/details.

For example, consider the following mapping:

• default => toroidal/adminDetails/default.md on non-Platen sites
• default => toroidal/adminDetails/platen.md on Platen sites
• none => toroidal/adminDetails/none.md
• myWebring/details => myWebring/details.md
• notMarkdown.thml => toroidal/adminDetails/notMarkdown.html`

If the partial file name has the .md or .markdown extension, the partial renders the Markdown to HTML.

You can override this setting for any webring by setting toroidal_admin_details in the administration page’s front matter.