Ingestion
45 terms described. A term is a word of the business with its definition, its aliases and the words it relates to.
| Term | aliases | First line | Links |
|---|---|---|---|
| Locale | BCP 47 tag, locale tag | The language of a source or of the project, written as a BCP 47 tag, en, fr, fr-CA. The locale of a source selects its language pack, the type prefixes of the profile for that language and the collation of its indexes; the locale of the project is the language of the interface, whose labels come from a message catalogue per locale, and the default locale of every source. A tag with no pack is a build error. | 81 |
| Lock | lock file | A versioned file in the configuration repository, concordance.lock.yaml, named by the lock key of the configuration, that records human decisions: accepted and rejected links, merged and separated twin resources, rejected candidate expressions, promoted emergent domains. The build reads it, validates it against the published lock schema and stops on a missing or invalid file as on a configuration error. It applies the rejected terms, compared on the normalised form of the language pack, so that a rejected expression has no candidate, no finding, no keyword page and no mark in the text, and the merged and separated pairs, a merged pair grouped under the criterion lock file whatever its score, a separated pair never reported, and the domains, a note the proposal reached filed under the domain of the integrator's choice unless a declaration files it already. The links are recorded, not read. The build log counts the decisions applied. Nothing is ever written into a knowledge repository. | 82 |
| Markdown | CommonMark, GFM | The only syntax the tool reads: CommonMark, the tables and task lists of GFM, and an optional YAML frontmatter. No wikilink, no directive, no proprietary tag: every note stays readable without the tool, and structured information goes through the frontmatter, the sections and the lists. A note is rendered to sanitised HTML at build, raw HTML dropped, its written links turned into page links. | 110 |
| Meeting | working session, session, minutes | A working session the documentation keeps as a note typed meeting: its minutes, with the date, the participants and the decision the session produced under decisions, the transcript of what was said and, when one was shown, the deck, grouped by the build as twin resources into one page with a tab per file. A meeting brings passages, not concepts: it enters the model through the pages it mentions and through the decision someone wrote as a note of its own, which the page names in a callout. | 75 |
| Note | typed note, fiche | A markdown file that the type cascade recognises as a typed entity: a screen, a rule, a business object, an API, a process, a decision, a term. A note has a page made of its rendered markdown first, at most five declared properties, then the occurrences found elsewhere. | 202 |
| Pipeline | build steps | The chain of steps concordance build runs in a fixed order, each a pure function of the outputs of the previous ones: configuration, ingestion, parsing, reading and conversion, typing, contract import, dictionary, scan, links, combination, relation typing, keyword discovery, twin resources, checks, writing of the model, theme, rendering, measurement. Every step reports its anomalies as findings and nothing stops the chain. By extension, the job of the forge that runs the build on every push and publishes the site. | 78 |
| Preview | PDF preview, previews | The PDF form of an office document, produced by the conversion at build and cached by fingerprint, or committed next to the original by its author; either way the page of the document opens it in the viewer on demand and the original stays downloadable. previews: false on a source keeps the PDFs out of the published site: the download link and the extracted text remain. A committed preview shares the base name of its original and repeats its text, two of the signals that make them twin resources. | 68 |
| Privacy | privacy block | The privacy: block of the configuration: exclude, the globs of what is never read, applied before any content (an excluded file, like the ones a repository excludes itself or git ignores); pseudonymize, the pseudonymisation of transcripts with its dictionary and scope; and publish_transcripts, false by default, so that a transcript is indexed only when a decision asks for it. The configuration never carries a credential either: a private source gets its token from the git environment of the machine or of the pipeline. | 35 |
| Profile | meta-model, default profile | The YAML file that describes the meta-model: types, their attributes, the relations and the pairs of types they may join, the sections whose heading maps to a relation, the confidence scale, the display rules. The engine knows nothing else. A project profile is merged over the default one; adding a type never requires a code change. | 136 |
| Project | project block, wiki project | The wiki being built, as the project: block of the configuration declares it: its name, shown in the site; its locale, the language of the interface and the default locale of the sources; its theme, the theme file relative to the configuration, theme.yaml next to it when the key is absent; its edit_url, the pattern of the edit link with {source}, {path} and {commit} placeholders, derived from the forge of a GitHub or GitLab source when absent; and its contribute_url, the HTTPS address every call to action of the site leads to when no forge link can be built for it, "Propose a definition" or "Edit this page", which the site leaves out rather than shows inert when neither is known. The project locale, the project profile and the project stylesheet are the ones this block, the profile and the theme name. | 151 |
| Pseudonymisation | pseudonymization, pseudonymise | The replacement of the speaker names of a transcript, and of the personal mentions detected in it, by stable pseudonyms before anything else reads it: privacy.pseudonymize in the configuration, off by default, with the types concerned, the dictionary pseudonyms.yaml of real names to pseudonyms that is never published, and whether a known role stands in for the pseudonym. A name pattern found outside the dictionary yields I-PII-DETECTED for review. Pseudonymisation is a mechanism, not a permission: transcripts are published only when privacy.publish_transcripts asks for it. | 60 |
| Reader | format reader | A contribution point of the plugin API that reads a file format: it receives the path and the raw bytes of a file and returns its native metadata (title, author, dates, counts) and its text, the cues of a transcript for the VTT reader. A reader is synchronous and pure, reads nothing but the bytes it is given, and throws a plain error naming the file when it cannot, which the pipeline turns into a finding. | 121 |
| Representation | form of a document | One of the files an entity is made of: its note, a slide deck, the PDF a converter produced from it, a transcript, the contract an operation was imported from. A note alone has one representation; twin resources merged into one entity carry several, and its page shows them one after the other, the file for download, its extracted text and its viewer. An office document without markdown next to it is reported by W-DOC-NOMD until a note becomes its representation. | 67 |
| Rule | business rule, rule note | An entity of type rule: a constraint with a severity and a condition, and an ## Applies to section naming the screens, processes, objects or APIs it constrains. The rules of this wiki describe the checks of the tool, one note per check, and the rule that binds the linter to the build. | 141 |
| Screen | screen note, page of an application | An entity of type screen: a page of an application, with the roles that use it, the objects it reads and writes, its actions leading to other screens and the rules that constrain it, declared in its frontmatter or under its ## Objects, ## Actions and ## Rules sections. The screens of this wiki are the pages of the generated site, one note per page slot, each with a ## Today section that says what the page renders in this version. | 91 |
| Section | note section | A part of a note under a heading of level one or two: the fragment of the note holds one rendered section per heading, every occurrence records the section it was read in, and a section whose heading the profile maps to a relation turns the notes named in it into section mentions. Headings are matched without regard to case or accents, in the language of the source. | 133 |
| Source | source repository, declared source | A git repository, or a local folder, declared in the configuration with its typing rules. Every entity's identifier starts with the name of its source, and every occurrence knows which source it came from. | 174 |
| Staleness | stale, dormant source | The age after which a source or a note is flagged W-STALE: staleness.warn_after_days in the configuration, a default and per-source overrides, the dates coming from git. The home page reads the same thresholds and marks a source dormant in its freshness entry when its newest change is older than its threshold at the instant of the build, 180 days without the key. | 53 |
| Step | pipeline step | One module of the pipeline, a pure function of the outputs of the steps before it that reports its anomalies as findings and never stops the chain. The architecture guide of the tool lists them in order; nothing after the writing of the model reads a source. | 78 |
| Transcript | meeting transcript, VTT file | The timed text of a meeting, a .vtt file that a reader turns into cues with their timecodes. Its words enter the search index and the occurrence scan once pseudonymisation has run, a mention read in it cites its timecode, and it is often a twin resource of the deck and the notes of the same meeting. A transcript is indexed only when the configuration publishes transcripts explicitly. | 92 |
20 ingestion of 45 — pagination by twenty. The Links column counts the related pages, which brings the most central ingestion of the journey to the top.