app.atmobb.forum.profile

lexicons.atmobb.app

Documentation

A forum's identity and configuration. Lives in the forum account's repo; the forum's DID is the forum's identity.

main record

A forum's identity and configuration. Lives in the forum account's repo; the forum's DID is the forum's identity.

Record Key literal:self Fixed literal value

Properties

avatar blob Optional

No description available.

maxSize: 1.0 MB
banner blob Optional

No description available.

maxSize: 2.0 MB
createdAt string datetime Optional

An RFC 3339 formatted timestamp.

customCss string Optional

Forum-owned CSS applied to public pages. Admin pages deliberately ignore it so a broken stylesheet can always be repaired.

maxLength: 100000 bytes
customFonts array of ref #font Optional

Forum-owned webfont faces available to customCss.

maxLength: 12 items
description string Optional

No description available.

maxLength: 10000 bytesmaxGraphemes: 1000 graphemes
favicon blob Optional

Forum-owned browser icon.

maxSize: 1.0 MB
hideCredit boolean Optional

Hide the 'powered by atmobb' badge in the page footer. Absent means shown.

hideDefaultStamps boolean Optional

Hide the board and arrival default stamps on member rails. The 'here since' line always shows. Absent means shown.

hideProfileSkins boolean Optional

Show every member profile page in the forum's own colors, ignoring members' profile skins. Banner patterns and headlines still show. Absent means skins show.

homepage ref #homepage Optional

Optional forum homepage presentation. Absent values retain the classic board index.

membership ref #membership Optional

How people join. Absent means open: declaring membership is joining.

name string Required

No description available.

maxLength: 1000 bytesmaxGraphemes: 100 graphemes
ogImage blob Optional

Forum-owned 1200 by 630 PNG used as the forum landing page's social preview image.

maxSize: 2.0 MB
ogTheme string Optional

Visual preset used by the generated forum landing page social preview.

maxLength: 32 bytes
Known values: classic, midnight, ocean, forest, plum
ranks array of ref #rank Optional

Deprecated and no longer rendered: post-count ranks gave way to stamps (app.atmobb.forum.stamp). Kept so older records still validate.

maxLength: 50 items
theme string Optional

Built-in color theme preset. Absent means the classic atmobb skin. Custom CSS loads after the preset and may override it.

maxLength: 32 bytes
Known values: classic, sky, bubblegum, midnight, forest
View raw schema 
{
  "description": "A forum's identity and configuration. Lives in the forum account's repo; the forum's DID is the forum's identity.",
  "key": "literal:self",
  "record": {
    "properties": {
      "avatar": {
        "accept": [
          "image/png",
          "image/jpeg",
          "image/webp"
        ],
        "maxSize": 1000000,
        "type": "blob"
      },
      "banner": {
        "accept": [
          "image/png",
          "image/jpeg",
          "image/webp"
        ],
        "maxSize": 2000000,
        "type": "blob"
      },
      "createdAt": {
        "format": "datetime",
        "type": "string"
      },
      "customCss": {
        "description": "Forum-owned CSS applied to public pages. Admin pages deliberately ignore it so a broken stylesheet can always be repaired.",
        "maxLength": 100000,
        "type": "string"
      },
      "customFonts": {
        "description": "Forum-owned webfont faces available to customCss.",
        "items": {
          "ref": "#font",
          "type": "ref"
        },
        "maxLength": 12,
        "type": "array"
      },
      "description": {
        "maxGraphemes": 1000,
        "maxLength": 10000,
        "type": "string"
      },
      "favicon": {
        "accept": [
          "image/png",
          "image/jpeg",
          "image/webp"
        ],
        "description": "Forum-owned browser icon.",
        "maxSize": 1000000,
        "type": "blob"
      },
      "hideCredit": {
        "description": "Hide the 'powered by atmobb' badge in the page footer. Absent means shown.",
        "type": "boolean"
      },
      "hideDefaultStamps": {
        "description": "Hide the board and arrival default stamps on member rails. The 'here since' line always shows. Absent means shown.",
        "type": "boolean"
      },
      "hideProfileSkins": {
        "description": "Show every member profile page in the forum's own colors, ignoring members' profile skins. Banner patterns and headlines still show. Absent means skins show.",
        "type": "boolean"
      },
      "homepage": {
        "description": "Optional forum homepage presentation. Absent values retain the classic board index.",
        "ref": "#homepage",
        "type": "ref"
      },
      "intro": {
        "description": "Rich welcome shown in the home page hero under the description. Absent means the hero shows the name and description only.",
        "items": {
          "refs": [
            "app.atmobb.richtext.block#text",
            "app.atmobb.richtext.block#quote",
            "app.atmobb.richtext.block#code"
          ],
          "type": "union"
        },
        "maxLength": 50,
        "type": "array"
      },
      "links": {
        "items": {
          "format": "uri",
          "type": "string"
        },
        "maxLength": 20,
        "type": "array"
      },
      "membership": {
        "description": "How people join. Absent means open: declaring membership is joining.",
        "ref": "#membership",
        "type": "ref"
      },
      "name": {
        "maxGraphemes": 100,
        "maxLength": 1000,
        "type": "string"
      },
      "ogImage": {
        "accept": [
          "image/png"
        ],
        "description": "Forum-owned 1200 by 630 PNG used as the forum landing page's social preview image.",
        "maxSize": 2000000,
        "type": "blob"
      },
      "ogTheme": {
        "description": "Visual preset used by the generated forum landing page social preview.",
        "knownValues": [
          "classic",
          "midnight",
          "ocean",
          "forest",
          "plum"
        ],
        "maxLength": 32,
        "type": "string"
      },
      "ranks": {
        "description": "Deprecated and no longer rendered: post-count ranks gave way to stamps (app.atmobb.forum.stamp). Kept so older records still validate.",
        "items": {
          "ref": "#rank",
          "type": "ref"
        },
        "maxLength": 50,
        "type": "array"
      },
      "rules": {
        "items": {
          "refs": [
            "app.atmobb.richtext.block#text",
            "app.atmobb.richtext.block#quote",
            "app.atmobb.richtext.block#code"
          ],
          "type": "union"
        },
        "maxLength": 50,
        "type": "array"
      },
      "theme": {
        "description": "Built-in color theme preset. Absent means the classic atmobb skin. Custom CSS loads after the preset and may override it.",
        "knownValues": [
          "classic",
          "sky",
          "bubblegum",
          "midnight",
          "forest"
        ],
        "maxLength": 32,
        "type": "string"
      }
    },
    "required": [
      "name"
    ],
    "type": "object"
  },
  "type": "record"
}
font object

No description available.

Properties

family string Required

No description available.

maxLength: 640 bytesmaxGraphemes: 64 graphemes
source blob Required

No description available.

maxSize: 2.0 MB
style string Required

No description available.

maxLength: 16 bytes
Known values: normal, italic
weight integer Required

No description available.

minimum: 100maximum: 900
View raw schema 
{
  "properties": {
    "family": {
      "maxGraphemes": 64,
      "maxLength": 640,
      "type": "string"
    },
    "source": {
      "accept": [
        "font/woff",
        "font/woff2"
      ],
      "maxSize": 2000000,
      "type": "blob"
    },
    "style": {
      "knownValues": [
        "normal",
        "italic"
      ],
      "maxLength": 16,
      "type": "string"
    },
    "weight": {
      "maximum": 900,
      "minimum": 100,
      "type": "integer"
    }
  },
  "required": [
    "family",
    "weight",
    "style",
    "source"
  ],
  "type": "object"
}
homepage object

No description available.

Properties

featuredThreads array of stringat-uri Optional

No description available.

maxLength: 3 items
layout string Optional

No description available.

maxLength: 32 bytes
Known values: boards, latest, categories-latest
sidebar boolean Optional

No description available.

welcome string Optional

No description available.

maxLength: 32 bytes
Known values: classic, compact, hidden
View raw schema 
{
  "properties": {
    "featuredThreads": {
      "items": {
        "format": "at-uri",
        "type": "string"
      },
      "maxLength": 3,
      "type": "array"
    },
    "layout": {
      "knownValues": [
        "boards",
        "latest",
        "categories-latest"
      ],
      "maxLength": 32,
      "type": "string"
    },
    "sidebar": {
      "type": "boolean"
    },
    "welcome": {
      "knownValues": [
        "classic",
        "compact",
        "hidden"
      ],
      "maxLength": 32,
      "type": "string"
    }
  },
  "type": "object"
}
membership object

Join policy for a forum. In the apply and invite modes only accounts the forum has accepted (an acceptMember moderation action) may post; reading stays public.

Properties

gatedSince string datetime Optional

When the forum last entered a gated mode. Posts written while the forum was open are served regardless of membership.

inviteCap integer Optional

Open invites an ordinary member may hold at once. 0 means only staff mint invites.

minimum: 0maximum: 100
inviteDays integer Optional

Days before an unredeemed invite expires.

minimum: 1maximum: 365
mode string Optional

No description available.

maxLength: 32 bytes
Known values: open, apply, invite
prompt string Optional

The one question shown on the application form in apply mode.

maxLength: 3000 bytesmaxGraphemes: 300 graphemes
View raw schema 
{
  "description": "Join policy for a forum. In the apply and invite modes only accounts the forum has accepted (an acceptMember moderation action) may post; reading stays public.",
  "properties": {
    "gatedSince": {
      "description": "When the forum last entered a gated mode. Posts written while the forum was open are served regardless of membership.",
      "format": "datetime",
      "type": "string"
    },
    "inviteCap": {
      "description": "Open invites an ordinary member may hold at once. 0 means only staff mint invites.",
      "maximum": 100,
      "minimum": 0,
      "type": "integer"
    },
    "inviteDays": {
      "description": "Days before an unredeemed invite expires.",
      "maximum": 365,
      "minimum": 1,
      "type": "integer"
    },
    "mode": {
      "knownValues": [
        "open",
        "apply",
        "invite"
      ],
      "maxLength": 32,
      "type": "string"
    },
    "prompt": {
      "description": "The one question shown on the application form in apply mode.",
      "maxGraphemes": 300,
      "maxLength": 3000,
      "type": "string"
    }
  },
  "type": "object"
}
rank object

No description available.

Properties

minPosts integer Required

No description available.

minimum: 0
title string Required

No description available.

maxLength: 640 bytesmaxGraphemes: 64 graphemes
View raw schema 
{
  "properties": {
    "minPosts": {
      "minimum": 0,
      "type": "integer"
    },
    "title": {
      "maxGraphemes": 64,
      "maxLength": 640,
      "type": "string"
    }
  },
  "required": [
    "title",
    "minPosts"
  ],
  "type": "object"
}

Lexicon Garden

@