pub.leaflet.publication

leaflet.pub

Documentation

Record declaring a publication

main record

Record declaring a publication

Record Key tid Timestamp-based ID

Properties

base_path string Optional

No description available.

description string Optional

No description available.

maxLength: 2000 bytes
icon blob Optional

No description available.

maxSize: 1.0 MB
name string Required

No description available.

maxLength: 2000 bytes
preferences ref #preferences Optional

No description available.

theme ref #theme Optional

No description available.

View raw schema 
{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "name"
    ],
    "properties": {
      "icon": {
        "type": "blob",
        "accept": [
          "image/*"
        ],
        "maxSize": 1000000
      },
      "name": {
        "type": "string",
        "maxLength": 2000
      },
      "theme": {
        "ref": "#theme",
        "type": "ref"
      },
      "base_path": {
        "type": "string"
      },
      "description": {
        "type": "string",
        "maxLength": 2000
      },
      "preferences": {
        "ref": "#preferences",
        "type": "ref"
      }
    }
  },
  "description": "Record declaring a publication"
}
preferences object

No description available.

Properties

showComments boolean Optional

No description available.

showInDiscover boolean Optional

No description available.

showMentions boolean Optional

No description available.

showPrevNext boolean Optional

No description available.

showRecommends boolean Optional

No description available.

View raw schema 
{
  "type": "object",
  "properties": {
    "showComments": {
      "type": "boolean",
      "default": true
    },
    "showMentions": {
      "type": "boolean",
      "default": true
    },
    "showPrevNext": {
      "type": "boolean",
      "default": true
    },
    "showInDiscover": {
      "type": "boolean",
      "default": true
    },
    "showRecommends": {
      "type": "boolean",
      "default": true
    }
  }
}
theme object

No description available.

Properties

pageWidth integer Optional

No description available.

minimum: 0maximum: 1600
showPageBackground boolean Optional

No description available.

View raw schema 
{
  "type": "object",
  "properties": {
    "primary": {
      "refs": [
        "pub.leaflet.theme.color#rgba",
        "pub.leaflet.theme.color#rgb"
      ],
      "type": "union"
    },
    "pageWidth": {
      "type": "integer",
      "maximum": 1600,
      "minimum": 0
    },
    "accentText": {
      "refs": [
        "pub.leaflet.theme.color#rgba",
        "pub.leaflet.theme.color#rgb"
      ],
      "type": "union"
    },
    "pageBackground": {
      "refs": [
        "pub.leaflet.theme.color#rgba",
        "pub.leaflet.theme.color#rgb"
      ],
      "type": "union"
    },
    "backgroundColor": {
      "refs": [
        "pub.leaflet.theme.color#rgba",
        "pub.leaflet.theme.color#rgb"
      ],
      "type": "union"
    },
    "backgroundImage": {
      "ref": "pub.leaflet.theme.backgroundImage",
      "type": "ref"
    },
    "accentBackground": {
      "refs": [
        "pub.leaflet.theme.color#rgba",
        "pub.leaflet.theme.color#rgb"
      ],
      "type": "union"
    },
    "showPageBackground": {
      "type": "boolean",
      "default": false
    }
  }
}

Lexicon Garden

@