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 |
|---|---|---|---|
| Twin resources | twins, representations of a document | Several files that are forms of the same document: a slide deck, its markdown notes, the transcript of the meeting where it was shown. The tool scores their likeness (same base name, same title, similar text, same commit, or an explicit declaration) and merges them into a single page when the score is high enough. Below that, it reports a candidate and waits for the lock. | 89 |
| Type | entity type, note type | One of the kinds of entity the profile declares: a screen, a rule, a business object, an API, an operation, a process, a decision, a term, a document among others, each with a label per locale, a glyph, a group, its attributes, the sections whose heading produces a relation, and its display rules. A type is active when the first version renders it and planned otherwise; a project profile adds one without a code change, and a type module carries one from a plugin or a folder of the project. The type of a note is decided by the type cascade, and a type the profile does not know yields W-TYPE-UNKNOWN. | 159 |
| Type cascade | typing cascade, cascade | The order in which the type of a note is decided: the default type of the source, then the type forced by the source, then the source's rules in order (folder, suffix, extension, frontmatter key), then the note's own frontmatter. The most specific wins, and the origin of the decision is kept on the entity and shown in the site. | 55 |
| Type module | type folder, types_dir | The distributable form of a type: a folder named after the type slug that carries everything the type needs, type.yaml with its declaration (group, glyph, attributes, the sections whose heading produces a relation, the display rules), messages/<locale>.json with the labels of the type, its attributes and its sections per interface language, template.md with its note template, and optionally schema.json for the items of its list attributes and components/ for a page, an attribute value or a section rendered specially. The core types are modules and the default profile is assembled from them; a project keeps its own modules in the folder its profile names under types_dir, and a plugin contributes modules through the types contribution point. The modules are merged before the keys of the project profile, plugins first; a module of a core type is refused, that type being extended through the profile, and two modules of one type are a configuration error. | 44 |
| Version | schema version, version key | The first key of every file the tool reads, version: 1 in this version: the configuration, the profile, the theme and the lock each name the version of the schema they follow, and a file of another version is refused with the path of the key. The tool itself carries a version too, written in the footer of the site and in the build block of the model, and every published package shares it. | 8 |
5 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.