orthography.canonical-form

Rationale

Canonical spelling and every admitted variant are entry-owned data. Exact authored replacements are distinguishable from semantic choices and from ordinary lowercase homographs.

Guidance

Use the canonical or explicitly authored orthographic form. Treat a lowercase common-English homograph as advisory unless typed or composition context proves Canon intent.

Checker behavior

Message

Write {captured} as {suggested}.

Applies in

• heading
• body
• blockquote
• list item
• table cell
• json key
• glossary term
• notation token

Detection

aspects

• case
• hyphenation
• inflection
• plural

kind

orthography

Authored examples and fix policies

subtypes

[
  {
    "examples": {
      "correct": [
        {
          "check_input": {
            "kind": "document"
          },
          "format": "text",
          "id": "canonical-multiword-case",
          "profile": "general-prose",
          "surface": "docs",
          "text": "Acuity Collapse"
        },
        {
          "check_input": {
            "kind": "document"
          },
          "format": "text",
          "id": "canonical-longest-surface",
          "profile": "general-prose",
          "surface": "docs",
          "text": "Acuity Collapse Early Fracture"
        },
        {
          "check_input": {
            "expectation": {
              "expected_kinds": [
                "axis"
              ],
              "kind": "entry"
            },
            "kind": "typed-value",
            "node": "glossary_term"
          },
          "format": "text",
          "id": "canonical-contextual-case-typed",
          "profile": "general-prose",
          "surface": "docs",
          "text": "Move"
        }
      ],
      "incorrect": [
        {
          "captured": "acuity collapse",
          "check_input": {
            "kind": "document"
          },
          "format": "text",
          "id": "noncanonical-case",
          "outcome_id": "violation",
          "profile": "general-prose",
          "suggested": "Acuity Collapse",
          "surface": "docs",
          "text": "acuity collapse"
        },
        {
          "captured": "acuity collapse early fracture",
          "check_input": {
            "kind": "document"
          },
          "format": "text",
          "id": "noncanonical-longest-surface",
          "outcome_id": "violation",
          "profile": "general-prose",
          "suggested": "Acuity Collapse Early Fracture",
          "surface": "docs",
          "text": "acuity collapse early fracture"
        },
        {
          "captured": "move",
          "check_input": {
            "expectation": {
              "expected_kinds": [
                "axis"
              ],
              "kind": "entry"
            },
            "kind": "typed-value",
            "node": "glossary_term"
          },
          "format": "text",
          "id": "typed-contextual-lowercase",
          "outcome_id": "contextual-lowercase",
          "profile": "general-prose",
          "suggested": "Move",
          "surface": "docs",
          "text": "move"
        }
      ]
    },
    "id": "case",
    "outcomes": [
      {
        "disposition": "deterministic",
        "fix": {
          "interactive": "auto",
          "unattended": "auto"
        },
        "id": "violation"
      },
      {
        "disposition": "advisory",
        "fix": {
          "interactive": "auto",
          "unattended": "retry"
        },
        "id": "contextual-lowercase"
      }
    ],
    "supersedes": []
  },
  {
    "examples": {
      "correct": [
        {
          "check_input": {
            "expectation": {
              "expected_kinds": [
                "axis"
              ],
              "kind": "entry"
            },
            "kind": "typed-value",
            "node": "glossary_term"
          },
          "format": "text",
          "id": "authored-plural",
          "profile": "general-prose",
          "surface": "docs",
          "text": "Bonds"
        }
      ],
      "incorrect": [
        {
          "captured": "Bondes",
          "check_input": {
            "expectation": {
              "expected_kinds": [
                "axis"
              ],
              "kind": "entry"
            },
            "kind": "typed-value",
            "node": "glossary_term"
          },
          "format": "text",
          "id": "wrong-plural",
          "outcome_id": "violation",
          "profile": "general-prose",
          "suggested": "Bonds",
          "surface": "docs",
          "text": "Bondes"
        }
      ]
    },
    "id": "plural",
    "outcomes": [
      {
        "disposition": "deterministic",
        "fix": {
          "interactive": "auto",
          "unattended": "auto"
        },
        "id": "violation"
      }
    ],
    "supersedes": []
  },
  {
    "examples": {
      "correct": [
        {
          "check_input": {
            "expectation": {
              "expected_kinds": [
                "axis"
              ],
              "kind": "entry"
            },
            "kind": "typed-value",
            "node": "glossary_term"
          },
          "format": "text",
          "id": "authored-inflection",
          "profile": "general-prose",
          "surface": "docs",
          "text": "Bond-level"
        }
      ],
      "incorrect": [
        {
          "captured": "Bondish",
          "check_input": {
            "expectation": {
              "expected_kinds": [
                "axis"
              ],
              "kind": "entry"
            },
            "kind": "typed-value",
            "node": "glossary_term"
          },
          "format": "text",
          "id": "wrong-inflection",
          "outcome_id": "violation",
          "profile": "general-prose",
          "suggested": "Bond-level",
          "surface": "docs",
          "text": "Bondish"
        }
      ]
    },
    "id": "inflection",
    "outcomes": [
      {
        "disposition": "deterministic",
        "fix": {
          "interactive": "auto",
          "unattended": "auto"
        },
        "id": "violation"
      }
    ],
    "supersedes": []
  },
  {
    "examples": {
      "correct": [
        {
          "check_input": {
            "expectation": {
              "expected_kinds": [
                "axis"
              ],
              "kind": "entry"
            },
            "kind": "typed-value",
            "node": "glossary_term"
          },
          "format": "text",
          "id": "authored-hyphenation",
          "profile": "general-prose",
          "surface": "docs",
          "text": "Bond-Move"
        }
      ],
      "incorrect": [
        {
          "captured": "Bond level",
          "check_input": {
            "expectation": {
              "expected_kinds": [
                "axis"
              ],
              "kind": "entry"
            },
            "kind": "typed-value",
            "node": "glossary_term"
          },
          "format": "text",
          "id": "wrong-hyphenation",
          "outcome_id": "violation",
          "profile": "general-prose",
          "suggested": "Bond-level",
          "surface": "docs",
          "text": "Bond level"
        }
      ]
    },
    "id": "hyphenation",
    "outcomes": [
      {
        "disposition": "deterministic",
        "fix": {
          "interactive": "auto",
          "unattended": "auto"
        },
        "id": "violation"
      }
    ],
    "supersedes": []
  }
]