Icosa Canon

notation rule

notation.forbidden-forms

Write a cell as two concatenated letters, capacity then domain. Separate a list of cells with commas; do not put a comma inside a cell. Do not join cells with a slash or an underscore, and do not write state with colons. Magnitude uses 0 for centered or a signed digit 1–3, never a repeated sign.

  • product: error
  • marketing: error
  • public: warning
  • docs: warning

Rationale

The capacity letters O F B V and the domain letters P E M R S are disjoint, so each forbidden form is decidable by POSITION rather than by the character alone. Comma, slash, underscore, colon and the sign markers all occur legally in icosa prose (OR,FM is a cell list, B+E- is a state, ABS_FLOOR is an identifier), so each pattern matches only where the notation grammar would never put that character: inside a cell, joining two cells, or doubling a sign.

Guidance

RB and MB are reversed-letter English, not cells; BR is Belonging, BM is Identification. OR,FM is a cell list; B+E- is a state; ABS_FLOOR is an identifier.

Checker behavior

Message

Forbidden notation form ({form}): {remedy}.

Applies in

  • heading
  • body
  • blockquote
  • list item
  • table cell
  • notation token

Detection

detector
notation.forbidden-forms
kind
delegated

Authored examples and fix policies

subtypes
[
  {
    "examples": {
      "correct": [
        {
          "check_input": {
            "kind": "document"
          },
          "format": "text",
          "id": "comma-correct",
          "profile": "general-prose",
          "surface": "docs",
          "text": "BE listed"
        }
      ],
      "incorrect": [
        {
          "captured": "F,M",
          "check_input": {
            "kind": "document"
          },
          "format": "text",
          "id": "comma-incorrect",
          "outcome_id": "violation",
          "profile": "general-prose",
          "suggested": "FM",
          "surface": "docs",
          "text": "write F,M here"
        }
      ]
    },
    "id": "comma-in-cell",
    "outcomes": [
      {
        "disposition": "structural",
        "fix": {
          "interactive": "suggest",
          "unattended": "retry"
        },
        "id": "violation"
      }
    ],
    "supersedes": [
      {
        "rule_id": "punctuation.canonical-separator",
        "subtype_id": "cell-separator"
      }
    ]
  },
  {
    "examples": {
      "correct": [
        {
          "check_input": {
            "kind": "document"
          },
          "format": "json",
          "id": "equals-correct",
          "profile": "crosswalk-data",
          "surface": "product",
          "text": "{\"mapping_rationale\":\"F0P0\"}"
        }
      ],
      "incorrect": [
        {
          "captured": "FP=",
          "check_input": {
            "kind": "document"
          },
          "format": "json",
          "id": "equals-incorrect",
          "outcome_id": "violation",
          "profile": "crosswalk-data",
          "surface": "product",
          "text": "{\"mapping_rationale\":\"FP=0\"}"
        }
      ]
    },
    "id": "equals-magnitude",
    "outcomes": [
      {
        "disposition": "structural",
        "fix": {
          "interactive": "retry",
          "unattended": "retry"
        },
        "id": "violation"
      }
    ],
    "supersedes": [
      {
        "rule_id": "punctuation.canonical-separator",
        "subtype_id": "state-magnitude-sign"
      }
    ]
  },
  {
    "examples": {
      "correct": [
        {
          "check_input": {
            "kind": "document"
          },
          "format": "text",
          "id": "slash-correct",
          "profile": "general-prose",
          "surface": "docs",
          "text": "cells OR,FM listed"
        }
      ],
      "incorrect": [
        {
          "captured": "OP/FE",
          "check_input": {
            "kind": "document"
          },
          "format": "text",
          "id": "slash-incorrect",
          "outcome_id": "violation",
          "profile": "general-prose",
          "surface": "docs",
          "text": "pair OP/FE shown"
        }
      ]
    },
    "id": "slash-pair",
    "outcomes": [
      {
        "disposition": "structural",
        "fix": {
          "interactive": "retry",
          "unattended": "retry"
        },
        "id": "violation"
      }
    ],
    "supersedes": [
      {
        "rule_id": "punctuation.canonical-separator",
        "subtype_id": "pair-separator"
      }
    ]
  },
  {
    "examples": {
      "correct": [
        {
          "check_input": {
            "kind": "document"
          },
          "format": "text",
          "id": "underscore-correct",
          "profile": "general-prose",
          "surface": "docs",
          "text": "ABS_FLOOR=0.70"
        }
      ],
      "incorrect": [
        {
          "captured": "O_P",
          "check_input": {
            "kind": "document"
          },
          "format": "text",
          "id": "underscore-incorrect",
          "outcome_id": "violation",
          "profile": "general-prose",
          "suggested": "OP",
          "surface": "docs",
          "text": "key O_P legacy"
        }
      ]
    },
    "id": "underscore-cell",
    "outcomes": [
      {
        "disposition": "structural",
        "fix": {
          "interactive": "suggest",
          "unattended": "retry"
        },
        "id": "violation"
      }
    ],
    "supersedes": [
      {
        "rule_id": "punctuation.canonical-separator",
        "subtype_id": "cell-separator"
      }
    ]
  },
  {
    "examples": {
      "correct": [
        {
          "check_input": {
            "kind": "document"
          },
          "format": "text",
          "id": "colon-correct",
          "profile": "general-prose",
          "surface": "docs",
          "text": "state B+E- shown"
        }
      ],
      "incorrect": [
        {
          "captured": "B:E:",
          "check_input": {
            "kind": "document"
          },
          "format": "text",
          "id": "colon-incorrect",
          "outcome_id": "violation",
          "profile": "general-prose",
          "surface": "docs",
          "text": "state B:E: legacy"
        }
      ]
    },
    "id": "colon-state",
    "outcomes": [
      {
        "disposition": "structural",
        "fix": {
          "interactive": "retry",
          "unattended": "retry"
        },
        "id": "violation"
      }
    ],
    "supersedes": [
      {
        "rule_id": "punctuation.canonical-separator",
        "subtype_id": "state-magnitude-sign"
      }
    ]
  },
  {
    "examples": {
      "correct": [
        {
          "check_input": {
            "kind": "document"
          },
          "format": "text",
          "id": "sign-correct",
          "profile": "general-prose",
          "surface": "docs",
          "text": "magnitude B0E+3 shown"
        }
      ],
      "incorrect": [
        {
          "captured": "O---E--",
          "check_input": {
            "kind": "document"
          },
          "format": "text",
          "id": "sign-incorrect",
          "outcome_id": "violation",
          "profile": "general-prose",
          "suggested": "O-3E-2",
          "surface": "docs",
          "text": "level O---E-- deep"
        }
      ]
    },
    "id": "repeated-sign",
    "outcomes": [
      {
        "disposition": "deterministic",
        "fix": {
          "interactive": "auto",
          "unattended": "auto"
        },
        "id": "violation"
      }
    ],
    "supersedes": [
      {
        "rule_id": "punctuation.canonical-separator",
        "subtype_id": "state-magnitude-sign"
      }
    ]
  }
]