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 |
|---|---|---|---|
| API | application programming interface, api note | An entity of type api: an interface another system calls, with its protocol, its exposure, its version, its consumers and the objects it gives access to, and the contract that describes it, which the contract import turns into operations. The page of an API lists its operations and carries the contract viewer; an API that nothing consumes yields W-API-NOCONSUMER. | 68 |
| Application | applications, application container | A container of first level, declared under applications: of the configuration with an id, a title and a status (active, legacy or target). Every entity is resolved to one in increasing precedence: the application of its source, the set: { application } of a typing rule, the application of its frontmatter. An entity without one yields W-APP-MISSING, one naming an undeclared identifier W-APP-UNKNOWN; the search results and the breadcrumb of a page show the application an entity is filed under. | 66 |
| Attribute | frontmatter attribute, declared attribute, property | A key of the frontmatter that the profile declares, either for every type (id, title, aliases, status, summary among the common ones) or for one type (url_pattern of a screen, severity of a rule, broader of a term). A typed attribute carries a string, a date, an enum, a list or a reference; a reference produces a link whose relation the profile names. The page shows the attributes in its side panel and highlights the first ones the type's display rules list; a key nothing declares yields W-ATTRIBUTE-UNKNOWN. | 132 |
| Build | concordance build, build block | One run of concordance build: it validates the configuration and the lock it names, fetches the sources, runs the inference chain and the checks, writes the model, the build log and one fragment per entity, then renders the site from those files alone. The build: block of the configuration says where it writes (output, ./dist), when it fails (fail_on.errors, fail_on.unconverted_max), how many mentions a page carries inline (mentions_inline, 20) and how much of a note enters the search index (extracted_text_max_chars, 20 000). The build block of the model is its only dated part. | 229 |
| Configuration | concordance.yaml, configuration file | The file concordance.yaml of the configuration repository, validated by the published configuration schema and read first by every command: its version, the project, the profile, the plugins, the applications, the domains, the privacy block, the sources, the staleness thresholds, the inference options, the conversion limits, the build block, the site options, the checks overrides and the lock. concordance validate-config prints one line per faulty key; concordance init writes a commented one. | 131 |
| Configuration repository | wiki repository, config repository | The repository that holds the configuration, the profile override, the theme, the stopword files, the lock and the pipeline that builds the site and publishes it, and no content: the notes stay in the knowledge repositories it declares as sources. Copying it is how a wiki of one's own starts. | 63 |
| Conversion | office conversion, conversion block | The transformation of an office document into a PDF at build, by a converter plugin, so that its text is extracted from that PDF and nothing else, and the conversion: block of the configuration that bounds it: timeout_s (120) per document, max_size_mb (50) beyond which a file stays unconverted, cache, the fingerprint cache outside dist/, and parallelism, the number of concurrent conversions, which changes the build time and never the output. A document that fails to convert yields W-CONV-FAILED and stays downloadable; no converter runs in this version. | 64 |
| Converter | office converter | A contribution point of the plugin API that turns a document into representations the pipeline reads: a PDF today, thumbnails and text later, written under the fingerprint cache and never next to the source. A converter receives the bytes of the file, their SHA-256 and the limits of conversion: (timeout_s, max_size_mb), runs in a pool of conversion.parallelism workers, and reports a failed conversion as W-CONV-FAILED, the document staying a download. The official converter drives headless LibreOffice; no converter runs in this version. | 62 |
| Corpus | knowledge corpus | The notes and documents of every source a build reads together: what the dictionary, the search index and the alphabetical index cover, and what a candidate expression recurs across. A golden corpus is a fixed corpus with the model the engine must produce from it. | 97 |
| Cue | timed cue, timecode | One timed unit of a transcript: a start and an end timecode and the words spoken between them. A cue is the position of a word read in a transcript, as a page or a slide is in a converted document: a mention cites it by its timecode, and the rail of the document viewer lists the cues with the first line of their text. | 79 |
| Deck | slide deck, slides, slide | A slide presentation, a .pptx file that a converter turns into a PDF at build so that the site previews it and reads its text slide by slide. Its page offers the original for download, the PDF the conversion produced or the preview committed next to it, a rail of its slides captioned by their first line and the extracted text of every slide; a mention read in a deck cites its slide. A deck is often a twin resource of the notes and the transcript of the session where it was shown. | 73 |
| Document | raw document, untyped resource | A resource that no rule types: a markdown file left as-is, a slide deck, a Word file, a PDF, a transcript. A document is indexed and its words are recorded from its extracted text, but it enters the model only through what it documents. Its page offers the file for download, shows its extracted text page by page and, when the conversion produced a PDF, opens it in a viewer on demand. | 150 |
| Domain | business domain, global domain | A business grouping declared globally, by the name of a folder of the corpus (a folder domain) or by glob patterns evaluated across every source, or proposed by the neighbourhood as an emergent domain for a corpus nobody filed. Repositories are usually split by kind of document; domains cut across them. A note outside every domain lands in the unclassified domain and gets a finding. | 78 |
| Emergent domain | suggested domain, proposed domain | A domain the build proposes from the neighbourhood rather than reads from the configuration, for a corpus nobody filed yet. Every term with a note of its own whose distinct neighbours, over the typed links and the co-occurrences, reach min_neighbours is a pivot; every note no frontmatter, folder or glob files that lies within radius edges of a pivot is a candidate for a domain named after it, attached to the closest pivot, at equal distance to the one of highest degree. A stopword or a term the lock rejects never pivots. The proposal reads as one I-DOMAIN-SUGGESTED finding per reached note and as a section of the build log; nothing is assigned unless the configuration says so, because a growing corpus moves its pivots. A proposal is promoted by declaring the domain, or by naming the note under domains in the lock, and every entity records the origin of its domain: frontmatter, folder, glob, unclassified, lock or inferred. | 51 |
| Extracted text | text of a document, extracted pages | The words of a document as the build reads them: the text of every page of the PDF the converter produced, or of the PDF given as a source, and the cues of a transcript with their timecodes. An office document never gives its text any other way, so that one extraction path serves every format. The extracted text feeds the search index, the recognition of occurrences and the comparison of twin resources, each word keeping the page, slide or cue it was read on, so that a mention cites slide 3 where a note cites a line. The page of the document shows it position by position, cut at the configured size; the download gives the rest. | 58 |
| Fingerprint cache | conversion cache, pipeline cache | The folder, .concordance-cache by default (conversion.cache), where the build keeps what it fetched or produced, keyed by the fingerprint of its input: a converted document under convert/<sha256 of the file>, so that an unchanged document is never reconverted even when it moves, and a contract by the SHA-256 of its text. The clones of the sources sit under it too. The cache never enters dist/; a pipeline keeps it between runs and deleting it forces a full reconversion. | 30 |
| Folder domain | domain folder, domain by folder | A domain recognised by the name of a folder of the corpus rather than by glob patterns: folder: true claims every note with a directory named after the domain's identifier on its path, in any source, and folder: <name> those under a folder of another name; the file name itself never counts. A subdomain declared this way claims only the notes under its parent's folder, or anywhere on a path the parent's globs match when the parent is declared by globs. Folders and globs combine on one domain with the same precedence, the deepest domain first, and a frontmatter domain still wins over both. | 18 |
| Frontmatter | YAML frontmatter | The YAML block between two --- lines at the top of a note: the common attributes every entity may declare (id, type, title, aliases, application, domain, status, tags, summary, superseded_by, locale) and the attributes of its type, a frontmatter reference among them. The frontmatter is the last rung of the type cascade, is never scanned for occurrences, yields E-FM-INVALID when it does not parse and W-ATTRIBUTE-UNKNOWN for a key nothing declares. What qualifies goes in it; the rest is prose. | 96 |
| Identifier | entity identifier, id | The name of an entity in the model and the address of its page: the name of its source, then its path relative to the source root without the extension or the type suffix, slugified segment by segment (lowercase, accents removed, every other run of characters replaced by one hyphen), glossary/ingestion/typing/identifier for this repository's ingestion/typing/identifier.md. A frontmatter id takes precedence when it follows the pattern, lowercase with hyphens and at least one slash, and yields E-ID-INVALID otherwise; two files resolving to one identifier yield E-ID-DUP and the first in source and path order is kept. Nothing random, nothing that depends on the order of processing. | 138 |
| Knowledge repository | repository, content repository | A git repository, or a local folder, that holds notes and documents and is declared as a source of the wiki. The tool never writes into it, each knowledge repository lints itself in its merge requests with the linter, and this glossary and the specifications of the tool are two of them. A repository that holds the configuration and no content is the configuration repository. | 148 |
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.