document.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "AUAUST-TOOLS-InDesign-Schemas-Document",
  "title": "AUAUST TOOLS — InDesign — Document schema",
  "description": "A .aajson file formatted as JSON containing the settings for a generated InDesign document.",
  "type": "object",
  "additionalProperties": false,
  "definitions": {
    "unit": {
      "anyOf": [
        {
          "type": "number",
          "description": "When set to a number without an unit, the unit used is the one set in the general `document.aajson` config. If it isn't there, it fallbacks to `um`."
        },
        {
          "type": "string",
          "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:pt|mm|cm|in|i|um|)$"
        }
      ]
    },
    "renderingIntents": {
      "anyOf": [
        {
          "const": "ABSOLUTE_COLORIMETRIC",
          "description": "Maintains color accuracy at the expense of preserving relationships between colors; most suitable for previewing how paper color affects printed colors."
        },
        {
          "const": "PERCEPTUAL",
          "description": "Preserves the visual relationship between colors at the expense of actual color values; most suitable for photographic images with high percentages of out-of-gamut colors."
        },
        {
          "const": "RELATIVE_COLORIMETRIC",
          "description": "Compares the extreme highlight of the source color space to that of the desination color space and shifts all colors accordingly; out-of-gamut colors are shifted to the closest reproducible color in the destination color space."
        },
        {
          "const": "SATURATION",
          "description": "Produces vivid colors at the expense of color accuracy; most suitable for business graphics such as graphs or charts."
        },
        {
          "const": "USE_COLOR_SETTINGS",
          "description": "Uses the current color settings."
        }
      ]
    },
    "id": { "type": "string", "pattern": "^[a-zA-Z0-9_.-]+$" }
  },
  "properties": {
    "file": {
      "type": "object",
      "description": "The file settings.",
      "additionalProperties": false,
      "required": ["project"],
      "properties": {
        "name": {
          "type": "string",
          "markdownDescription": "The name of the generated InDesign document. Used for the file name and the metadata title.  \n\nA few useful placeholders are available, such as:  \n`{project}` (the project name specified in the `file.project` key), `{script}` (the script name, which is probably 'GENERATE'), and dates such as `{YYYY}`, `{YY}`, `{MM}`, `{mm}`, `{ss}` etc.  \n\n__Note__: Do not include the file extension."
        },
        "project": {
          "type": "string",
          "minLength": 1,
          "description": "The project name. Is used to determine the value of the {project} placeholder.\n\nUpper case letters are recoomended."
        },
        "intent": {
          "type": "string",
          "markdownDescription": "The final intent of the document.  \nEither it's for `WEB`, `MOBILE` or `PRINT`.",
          "enum": ["WEB", "MOBILE", "PRINT"]
        },
        "save": {
          "type": "boolean",
          "markdownDescription": "Whether or not to save the generated InDesign document automatically.  \n\n__Note__: The main change is that you won't be prompted to select a folder twice, but you'll need to save the file later.",
          "default": true
        },
        "debug": {
          "type": "boolean",
          "markdownDescription": "Whether or not to show debug information.  \n\n__Note__: Setting it to false disables all feedbacks, including helpful information. There's very little reason to set it to false.",
          "default": true
        },
        "colors": {
          "type": "object",
          "description": "The colors management settings.",
          "additionalProperties": false,
          "properties": {
            "transparency": {
              "type": "string",
              "markdownDescription": "The color mode for handling transparencies.  \nEither it's `CMYK` or `RGB`.",
              "enum": ["CMYK", "RGB"]
            },
            "profiles": {
              "type": "object",
              "description": "The color profiles settings.",
              "additionalProperties": false,
              "properties": {
                "CMYK": {
                  "type": "string",
                  "markdownDescription": "The CMYK color profile to use.  \nYou can use the wildcard `*` to allow any character(s) at that place, if you don't know the exact name.  \n\n__Note__: The color profile must be installed on the system."
                },
                "RGB": {
                  "type": "string",
                  "markdownDescription": "The RGB color profile to use.  \nYou can use the wildcard `*` to allow any character(s) at that place, if you don't know the exact name.  \n\n__Note__: The color profile must be installed on the system."
                }
              }
            },
            "policies": {
              "type": "object",
              "description": "The color policies settings.",
              "additionalProperties": false,
              "properties": {
                "CMYK": {
                  "description": "The CMYK color policies settings.  \nThey describe how imported and embedded colors should be handled, when using images for exemple.",
                  "anyOf": [
                    {
                      "const": "OFF",
                      "description": "Turns off color management for documents whose profiles do not match the working space. For imported colors, numeric values override color appearance."
                    },
                    {
                      "const": "PRESERVE_AND_SAFE_CMYK",
                      "description": "Preserves raw color numbers and ignores embedded color profiles."
                    },
                    {
                      "const": "CONVERT_TO_WORKING_SPACE",
                      "description": "Converts newly opened documents to the current working space. For imported colors, color appearance overrides numeric values."
                    },
                    {
                      "const": "PRESERVE_EMBEDDED_PROFILES",
                      "description": "Preserves embedded color profiles in newly opened documents."
                    }
                  ]
                },
                "RGB": {
                  "description": "The RGB color policies settings.  \nThey describe how imported and embedded colors should be handled, when using images for exemple.",
                  "anyOf": [
                    {
                      "const": "OFF",
                      "description": "Turns off color management for documents whose profiles do not match the working space. For imported colors, numeric values override color appearance."
                    },
                    {
                      "const": "PRESERVE_AND_SAFE_RGB",
                      "description": "Preserves raw color numbers and ignores embedded color profiles."
                    },
                    {
                      "const": "CONVERT_TO_WORKING_SPACE",
                      "description": "Converts newly opened documents to the current working space. For imported colors, color appearance overrides numeric values."
                    },
                    {
                      "const": "PRESERVE_EMBEDDED_PROFILES",
                      "description": "Preserves embedded color profiles in newly opened documents."
                    }
                  ]
                }
              }
            },
            "intents": {
              "type": "object",
              "description": "The color intents settings.",
              "additionalProperties": false,
              "properties": {
                "afterBlending": {
                  "description": "The rendering intent for colors that result from transparency interactions on the page after blending.",
                  "$ref": "#/definitions/renderingIntents"
                },
                "images": {
                  "description": "The rendering intent for bitmap (non-vector) images.",
                  "$ref": "#/definitions/renderingIntents"
                },
                "vector": {
                  "description": "The rendering intent for all vector art (areas of solid color) in native objects.",
                  "$ref": "#/definitions/renderingIntents"
                }
              }
            }
          }
        }
      }
    },
    "document": {
      "type": "object",
      "description": "The document's overall layout settings.",
      "additionalProperties": false,
      "properties": {
        "language": {
          "type": "string",
          "definition": "The document's language, used for hyphenation and other language-specific features if not otherwise specified (for exemple in paragraph styles).",
          "$ref": "https://raw.githubusercontent.com/AUAUST/tools-indesign-schemas/main/styles.json#/definitions/language"
        },
        "defaultUnit": {
          "type": "string",
          "markdownDescription": "The default unit to use for measurements.  \nEither it's `POINTS`, `MM`, `CM`, `INCHES`, or, obviously, `UM`.  \n\nIt is used for unit set a numbers, but can easily be overridden in specific places by specifying the unit in the string.",
          "enum": [
            "mm",
            "millimeters",
            "cm",
            "centimeters",
            "points",
            "pt",
            "inches",
            "i",
            "in",
            "um",
            "unité minimale",
            "MM",
            "CM",
            "POINTS",
            "PT",
            "INCHES",
            "I",
            "IN",
            "UM"
          ]
        },
        "pages": {
          "type": "object",
          "description": "The document's pages settings.",
          "additionalProperties": false,
          "properties": {
            "facing": {
              "type": "boolean",
              "description": "If true, the document has facing pages."
            },
            "from": {
              "type": "integer",
              "description": "The starting page number for a document. This is the same as the starting page number for the first section of a document.",
              "default": 1,
              "minimum": 1,
              "maximum": 999999
            },
            "count": {
              "type": "integer",
              "description": "The number of pages in the document.",
              "default": 1,
              "minimum": 1,
              "maximum": 9999
            }
          }
        },
        "dimensions": {
          "type": "object",
          "description": "The document's dimensions settings.",
          "additionalProperties": false,
          "properties": {
            "width": {
              "definition": "The document's width.",
              "$ref": "#/definitions/unit"
            },
            "height": {
              "definition": "The document's height.",
              "$ref": "#/definitions/unit"
            }
          }
        },
        "margins": {
          "type": "object",
          "description": "The document's margins settings.",
          "additionalProperties": false,
          "properties": {
            "top": {
              "description": "The document's top margin.",
              "$ref": "#/definitions/unit"
            },
            "inner": {
              "description": "The document's inner margin, or left margin if it hasn't facing pages.",
              "$ref": "#/definitions/unit"
            },
            "outer": {
              "description": "The document's outer margin, or right margin if it hasn't facing pages.",
              "$ref": "#/definitions/unit"
            },
            "bottom": {
              "description": "The document's bottom margin.",
              "$ref": "#/definitions/unit"
            }
          }
        },
        "bleed": {
          "type": "object",
          "description": "The document's bleed settings.",
          "additionalProperties": false,
          "properties": {
            "top": {
              "description": "The document's top bleed.",
              "$ref": "#/definitions/unit"
            },
            "inner": {
              "description": "The document's left bleed, or inner bleed if it has facing pages.",
              "$ref": "#/definitions/unit"
            },
            "outer": {
              "description": "The document's right bleed, or outer bleed if it has facing pages.",
              "$ref": "#/definitions/unit"
            },
            "bottom": {
              "description": "The document's bottom bleed.",
              "$ref": "#/definitions/unit"
            }
          }
        },
        "grid": {
          "type": "object",
          "description": "The document's grid settings, including baseline grid, columns and gutters.",
          "additionalProperties": false,
          "properties": {
            "columns": {
              "type": "integer",
              "description": "The number of columns in the document.",
              "default": 1,
              "minimum": 1,
              "maximum": 216
            },
            "gutter": {
              "description": "The document's gutter.",
              "$ref": "#/definitions/unit"
            },
            "visible": {
              "type": "boolean",
              "description": "If true, the document's baseline grid is visible.",
              "default": false
            },
            "startAt": {
              "type": "integer",
              "description": "The amount to offset the baseline grid from the zero point.",
              "default": 1,
              "minimum": 1,
              "maximum": 216
            },
            "relativeTo": {
              "description": "The zero point for the baseline grid offset.",
              "anyOf": [
                {
                  "const": "MARGIN",
                  "description": "The baseline grid offset zero point is at the top page margin."
                },
                {
                  "const": "PAGE",
                  "description": "The baseline grid offset zero point is at the top of the page."
                }
              ]
            },
            "lineHeight": {
              "description": "The amount of space between baseline grid lines.",
              "$ref": "#/definitions/unit"
            },
            "color": {
              "description": "The color of the baseline grid.",
              "type": "array",
              "items": {
                "type": "integer",
                "minimum": 0,
                "maximum": 255
              },
              "minItems": 3,
              "maxItems": 3
            },
            "threshold": {
              "type": "integer",
              "description": "The magnification (as a percentage of the document view) less than which ruler guides do not appear.",
              "default": 75,
              "minimum": 5,
              "maximum": 4000
            },
            "snapTo": {
              "type": "boolean",
              "description": "If true, an object snaps to the nearest grid line when the object is created, moved, or resized.",
              "default": false
            }
          }
        }
      }
    }
  }
}