Type Alias Module

Type Declaration

• { arguments: AttributeMap; body?: string; module: "unknown"; name: string }

  • arguments: AttributeMap

  • Optionalbody?: string

  • module: "unknown"

    Unrecognized module — preserves raw arguments for pass-through

  • name: string

• { module: "backlinks"; page: string | null }

  • module: "backlinks"

    [[module Backlinks]] — lists pages that link to a given page

  • page: string | null

    Target page, or null for the current page

• { "include-hidden": boolean; module: "categories" }

  • include-hidden: boolean

    Whether to include categories marked as hidden

  • module: "categories"

    [[module Categories]] — lists site categories

• { attributes: AttributeMap; "button-text": string | null; module: "join" }

  • attributes: AttributeMap

  • button-text: string | null

  • module: "join"

    [[module Join]] — site membership join button

• {
      depth: number | null;
      module: "page-tree";
      root: string | null;
      "show-root": boolean;
  }

  • depth: number | null

    Max depth, or null for unlimited

  • module: "page-tree"

    [[module PageTree]] — hierarchical page tree

  • root: string | null

    Root page, or null for the site root

  • show-root: boolean

• RateModuleData
• CustomRateModuleData
• {
      category: string | null;
      "font-size-unit": CssLengthUnit;
      limit: number;
      "max-color": [number, number, number];
      "max-font-size": number;
      "min-color": [number, number, number];
      "min-font-size": number;
      module: "tag-cloud";
      target: string;
  }

  • category: string | null

    Category filter, or null for all categories

  • font-size-unit: CssLengthUnit

    Unit shared by both font sizes (lowercase)

  • limit: number

    Maximum number of tags to display

  • max-color: [number, number, number]

    RGB components for the heaviest-weighted tag

  • max-font-size: number

    Numeric part of the font size for the heaviest-weighted tag

  • min-color: [number, number, number]

    RGB components for the lightest-weighted tag

  • min-font-size: number

    Numeric part of the font size for the lightest-weighted tag

  • module: "tag-cloud"

    [[module TagCloud]] — weighted cloud of page tags

  • target: string

    Normalized link target prefix, always ending with /tag/

• { attributes: AttributeMap; body?: string; module: "list-users"; users: string }

  • attributes: AttributeMap

  • Optionalbody?: string

    Template body with %%variable%% placeholders

  • module: "list-users"

    [[module ListUsers]] — user listing with template body

  • users: string

    User selector expression (e.g. "." for current user)

• {
      "append-line"?: string;
      attributes: AttributeMap;
      body?: string;
      category?: string;
      "created-at"?: string;
      "created-by"?: string;
      fullname?: string;
      limit?: number;
      "link-to"?: string;
      module: "list-pages";
      name?: string;
      offset?: number;
      order?: string;
      pagetype?: string;
      parent?: string;
      "per-page"?: number;
      "prepend-line"?: string;
      range?: string;
      rating?: string;
      "rating-axis"?: string;
      reverse: boolean;
      rss?: string;
      "rss-description"?: string;
      "rss-home"?: string;
      "rss-limit"?: number;
      "rss-only": boolean;
      separate: boolean;
      tags?: string;
      "updated-at"?: string;
      "url-attr-prefix"?: string;
      votes?: string;
      wrapper: boolean;
  }

  • Optionalappend-line?: string

  • attributes: AttributeMap

  • Optionalbody?: string

    Template body with %%variable%% placeholders

  • Optionalcategory?: string

  • Optionalcreated-at?: string

  • Optionalcreated-by?: string

  • Optionalfullname?: string

  • Optionallimit?: number

  • Optionallink-to?: string

  • module: "list-pages"

    [[module ListPages]] — the most complex module. Queries pages by various criteria and renders each through a template body.

  • Optionalname?: string

  • Optionaloffset?: number

  • Optionalorder?: string

  • Optionalpagetype?: string

  • Optionalparent?: string

  • Optionalper-page?: number

  • Optionalprepend-line?: string

  • Optionalrange?: string

  • Optionalrating?: string

  • Optionalrating-axis?: string

  • reverse: boolean

  • Optionalrss?: string

  • Optionalrss-description?: string

  • Optionalrss-home?: string

  • Optionalrss-limit?: number

  • rss-only: boolean

  • separate: boolean

  • Optionaltags?: string

  • Optionalupdated-at?: string

  • Optionalurl-attr-prefix?: string

    Prefix for URL path parameters (HPC support)

  • Optionalvotes?: string

  • wrapper: boolean