view release on metacpan or  search on metacpan

lib/ChordPro/res/config/config.schema  view on Meta::CPAN

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://json.schemastore.org/chordpro.json",
  "title": "Configuration for ChordPro",
  "description": "See the ChordPro website for more details: https://www.chordpro.org/chordpro/chordpro-configuration-file/.\nThis is a really relaxed JSON document, see https://metacpan.org/pod/JSON::Relaxed#REALLY-RELAXED-EXTENSIONS",
  "definitions": {
    "backendspec": {
      "description": "Standard properties for backends.",
      "type": "object",
      "properties": {
        "comments": {
          "description": "Retain comments in the output.",
          "enum": ["ignore", "retain"],
          "type": "string",
          "default": "ignore"
        }
      }
    },
    "themeColor": {
      "type": "string",
      "description": "Names of colours in theme.",
      "enum": [
        "foreground",
        "foreground-medium",
        "foreground-light",
        "background"
      ]
    },
    "colorspec": {
      "title": "Colour specification.",
      "type": "string",
      "oneOf": [
        {
          "description": "Hex colour",
          "pattern": "^#[0-9A-Fa-f]{6}$",
          "format": "color",
          "examples": ["#FFFFFF", "#393939"]
        },
        {
          "description": "Named colour",
          "anyOf": [
            {
              "title": "Shade of grey",
              "pattern": "^grey\\d{2}$"
            },
            {
              "title": "Colour name",
              "enum": [
                "red",
                "green",
                "blue",
                "yellow",
                "magenta",
                "cyan",
                "black",
                "white"
              ]
            },
            {
              "title": "A lack of colour, transparent",
              "const": "none"
            },
            {
              "title": "Any named colour",
              "pattern": "^[-A-Za-z0-9]+$"
            }
          ]
        }
      ],
      "not": {
        "$ref": "#/definitions/themeColor"
      }
    },
    "color": {
      "oneOf": [
        {
          "$ref": "#/definitions/themeColor"
        },
        {
          "$ref": "#/definitions/colorspec"
        }
      ]
    },
    "chordDiagramPDFLayout": {
      "type": "object",
      "properties": {
        "show": {
          "description": "Diagrams for the chords of the song can be shown at the `\"top\"`, `\"bottom\"` or `\"right\"` side of the first page, or `\"below\"` the last song line. Set to `false` to not show any diagrams.",
          "oneOf": [
            {
              "type": "string"
            },
            {
              "const": false
            }
          ],
          "enum": ["top", "bottom", "below", "right", false],
          "default": "bottom"
        },
        "align": {
          "type": "string",
          "description": "Alignment for when `show` is set to `\"top\"`, `\"bottom\"` or `\"below\"`.",
          "enum": ["left", "right", "center", "spread"],
          "default": "left"
        }
      }
    },
    "pageFormat": {
      "description": "Page format.\nAll elements can have three fields, that are placed to the left side, centered, and right side of the page.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "title": {
          "$ref": "#/definitions/tptspec",
          "description": "Topmost title element.\nIt uses the `fonts.title` font."
        },
        "subtitle": {
          "$ref": "#/definitions/tptspec",
          "description": "Second title element.\nIt uses the `fonts.subtitle` font."
        },