view release on metacpan or  search on metacpan

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

                { "const": "style",
                  "title": "A style definition."
                },
                { "const": "stylemod",
                  "title": "A mdoification to an existing style."
                },
                { "const": "instrument",
                  "title": "Definition of an instrument."
                },
                { "const": "task",
                  "title": "A preview task."
                },
                { "type": "string"
                },
                { "type": "array",
                  "items": {
                    "type": "string"
                  },
                  "minItems": 1
                }  
              ]
            },
            "title": {
              "description": "Title for menus, choices, if applicable.",
              "type": "string"
            },
            "description": {
              "description": "Helpful descriptive text.",
              "type": "string"
            },
            "exclude_id": {
              "description": "Exclusive control.\nIf multiple configs have the same exclude_id, only one will be used.",
              "type": ["boolean","string"]
            },
            "default": {
              "description": "True if this is the default config for a specific type.\nDo not use unless you know what you are doing!",
              "type": "boolean"
            },
            "omit": {
              "description": "Do not show this config in the GUI.",
              "type": "boolean"
            }
          },
          "additionalProperties": false
        },
        "include": {
          "type": "array",
          "description": "A config file can specify a list of other config files that are to be processed **before** the contents of the current file. This makes it straightforward to create config files that extend existing config files.\n`\"include...
          "items": {
            "type": "string"
          },
          "examples": [["guitar"]]
        },
        "settings": {
          "type": "object",
          "description": "General settings control global behaviour of the ChordPro program and can be changed by configs and command line.",
          "additionalProperties": false,
          "properties": {
            "chordnames": {
              "default": "strict",
              "description": "Strictness of parsing chord names.\nValues are `\"strict\"` (only known chord forms) or `\"relaxed\"` (anything that looks sane).",
              "enum": ["relaxed", "strict"],
              "type": "string"
            },
            "chords-canonical": {
              "default": false,
              "description": "Always replace chords by their canonical form.",
              "type": "boolean"
            },
            "chords-under": {
              "default": false,
              "description": "Chords under the lyrics.",
              "type": "boolean"
            },
            "choruslabels": {
              "default": true,
              "description": "If `false`, chorus labels are used as tags.",
              "type": "boolean"
            },
            "columns": {
              "default": 1,
              "description": "Either the number of columns, default: 1, or an array with column widths.",
              "examples": [2, ["*", "50%"], ["50%", "50%"], [0, 0]],
              "oneOf": [
                {
                  "description": "Equal width columns.",
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 3
                },
                {
                  "description": "An array of column widths.",
                  "items": {
                    "oneOf": [
                      {
                        "enum": ["*", 0],
                        "description": "Distributes the available width."
                      },
                      {
                        "pattern": "^\\d+%$",
                        "description": "Percentage of total width.",
                        "type": "string"
                      },
                      {
                        "description": "PDF points. `0` distributes the available width.",
                        "type": "number"
                      }
                    ]
                  },
                  "type": "array"
                }
              ],
              "title": "Columns."
            },
            "decapo": {
              "default": false,
              "description": "Eliminate capo by transposing chords.",
              "type": "boolean"
            },
            "common-keys": {
              "description": "Replace keys with more than 6 sharps or flats by their more common enharmonic equivalents.",