configuration/strings/ontology.strings.ts

configuration/strings/ontology.strings.ts is a file in Bane's Lab Site. 127 lines of code and 104 definitions.

import { ONTOLOGY_SHARE } from "#configuration/strings/page.strings";
import type { TabbedMeta } from "#types/document.types";

export const ONTOLOGY_META: TabbedMeta = {
    subtitle:
        "The ontology is a queryable canon of software architecture. It holds every principle with its relations and its repair, every term with its definition, every algorithm with its contract, the reasoning that derives them, the layers they live in and how every tension between them is resolved, and every reference from one record to another is a link.",
    title: ONTOLOGY_SHARE.headline,
    version: "1.0.0",
};

export const PRINCIPLES_LABEL = "Principles";
export const LEXICON_LABEL = "Lexicon";
export const ALGORITHMS_LABEL = "Algorithms";
export const REASONING_LABEL = "Reasoning";
export const SCHEMA_LABEL = "Schema";
export const GRAMMAR_LABEL = "Grammar";
export const TENSIONS_LABEL = "Tensions";

export const SEARCH_PLACEHOLDER = "Filter the records by name, id, kind or relation";
export const SEARCH_LABEL = "Filter";
export const SHOWN_LABEL = "shown";
export const OF_LABEL = "of";
export const CATEGORIES_LABEL = "Sections";
export const DETAILS_LABEL = "Details";
export const DIAGRAM_LABEL = "Relations diagram";

export const recordLinkText = function recordLinkText(title: string, section: string): string {
    return `${title} (${section})`;
};

export const sectionPageLabel = function sectionPageLabel(count: number, section: string): string {
    return `The ${String(count)} record${count === 1 ? "" : "s"} of ${section}`;
};

export const CATEGORY_INTRO =
    "Every principle in this category is listed as a record. Each record carries its kind, its severity, the scopes it applies at and the layer it lives in, then the edge relations that join it to other records, the records that point back at it, the contracts that answer to it and the tensions it takes part in. The descriptors say how it is violated, detected, measured, repaired and enforced. Where the record carries one, an exemplar shows the shape before and after the principle is applied.";
export const DOMAIN_INTRO =
    "Every algorithm contract in this domain is listed with its position on the derivation loop, its intent and invariant, the flow it walks and its productions as a grammar. Each record also shows what it composes and is composed by, which forces and principles it answers to, what grounds it and what it grounds, and an exemplar where the record carries one. The diagram shows what composes what inside the domain.";

export const resolutionNoteOf = function resolutionNoteOf(records: number, defects: number): string {
    return defects === 0
        ? `The canon resolves across all ${String(records)} records, because every edge names a record that exists, every kind is in range and every record has a check.`
        : `The canon does not fully resolve yet, because the resolution checks over its ${String(records)} records report ${String(defects)} defect${defects === 1 ? "" : "s"}.`;
};

export const REQUIRES_LABEL = "Requires";
export const REINFORCES_LABEL = "Reinforces";
export const ENABLES_LABEL = "Enables";
export const TENSIONS_WITH_LABEL = "In tension with";
export const CONFLICTS_WITH_LABEL = "Conflicts with";
export const REFERENCED_BY_LABEL = "Referenced by";
export const VIOLATED_BY_LABEL = "Violated by";
export const FORMED_BY_LABEL = "Formed by";
export const DETECTED_BY_LABEL = "Detected by";
export const MEASURED_BY_LABEL = "Measured by";
export const REFACTORED_BY_LABEL = "Refactored by";
export const ENFORCED_BY_LABEL = "Enforced by";
export const EXPRESSED_BY_LABEL = "Expressed in the grammar by";
export const KIND_LABEL = "Kind";
export const RECORD_LABEL = "Record";
export const CANONICAL_LABEL = "Canonical";
export const CLOSURE_LABEL = "Closure";
export const CLOSURE_LINK_LABEL = "Dependencies in load order";
export const SEVERITY_LABEL = "Severity";
export const SCOPE_LABEL = "Scope";
export const ALIASES_LABEL = "Aliases";
export const LAYER_LABEL = "Layer";
export const CATEGORY_LABEL = "Category";
export const TERM_LABEL = "Term";
export const CONTRACT_LABEL = "Contract";
export const CONTRACTS_LABEL = "Contracts";
export const BEFORE_TITLE = "Before";
export const AFTER_TITLE = "After";
export const STAGE_LABEL = "Stage";
export const AXIS_LABEL = "Axis";
export const MATH_TYPE_LABEL = "Math type";
export const YIELDS_LABEL = "Yields";
export const META_LABEL = "Meta record";
export const INTENT_LABEL = "Intent";
export const INVARIANT_LABEL = "Invariant";
export const FLOW_TITLE = "Flow";
export const PRODUCTIONS_TITLE = "Productions";
export const COMPOSES_LABEL = "Composes";
export const COMPOSED_BY_LABEL = "Composed by";
export const DERIVED_BY_LABEL = "Named in the derivation of";
export const DETECTS_LABEL = "Detector for";
export const GROUNDED_BY_LABEL = "Grounded by";
export const FORCES_LABEL = "Forces";
export const PRINCIPLE_LABEL = "Principle";
export const GROUNDS_LABEL = "Grounds";
export const DERIVATION_LABEL = "Derivation map";
export const DOMAIN_LABEL = "Domain";
export const MANDATORY_FOR_LABEL = "Mandatory for";
export const CANON_LABEL = "Refused by rules";
export const DISTINCT_FROM_LABEL = "Distinct from";
export const TIER_LABEL = "Tier";
export const COVERAGE_TITLE = "Check coverage";
export const DECLARED_ABSENT_LABEL = "declared absent";
export const DOCUMENT_TYPES_TITLE = "Document types";
export const KEYWORDS_KIND = "keywords";
export const PRODUCTIONS_KIND = "productions";
export const TEMPLATES_TITLE = "Templates";
export const KEYWORD_INTRO = "Every PAG keyword record, with what grounds it and how it is checked.";
export const PRODUCTION_INTRO = "Every PAG production record, with what grounds it and how it is checked.";
export const DOCUMENT_TYPE_INTRO = "Every PAG document type record, with what grounds it and how it is checked.";
export const TEMPLATE_INTRO = "Every PAG template record, with what grounds it and how it is checked.";
export const MEANING_LABEL = "Meaning";
export const EXAMPLE_LABEL = "Example";
export const RULE_LABEL = "Rule";
export const PURPOSE_LABEL = "Purpose";
export const DEFAULT_VERB_LABEL = "Default verb";
export const VERBS_LABEL = "Verbs";
export const MODEL_LABEL = "Model";
export const CONSTRAINTS_LABEL = "Constraints";
export const SLOTS_LABEL = "Slots";
export const TEMPLATE_BODY_TITLE = "Template body";
export const YES_LABEL = "yes";
export const NO_LABEL = "no";
export const NONE_LABEL = "none";
export const LIST_SEPARATOR = ", ";

export const unlabeledCoverage = function unlabeledCoverage(id: string): string {
    return `ontology: the check coverage names "${id}", and no label is declared for it. Declare the label beside the other check labels.`;
};

export const missingCheck = function missingCheck(ref: string): string {
    return `ontology: the resolution carries no check for ${ref}, so its record section cannot show how it is checked`;
};

export const missingVocabularySection = function missingVocabularySection(id: string): string {
    return `ontology: the vocabulary "${id}" has no section copy in VOCABULARY_SECTIONS. Add its copy there.`;
};

export const FIELD_SEPARATOR = " · ";
export const LABEL_SEPARATOR = ": ";
export const FLOW_ARROW = " → ";
export const PRODUCTION_ARROW = " ::= ";
export const CATEGORY_CAPTION = "The relations inside this category.";
export const DOMAIN_CAPTION = "What composes what inside this domain.";