Site
16 pages filed under Publication › site. A term is a word of the business with its definition, its aliases and the words it relates to.
| Term | aliases | First line | Links |
|---|---|---|---|
| Accessibility audit | accessibility checks, a11y audit | The set of verifications that hold every page of the site to the accessibility points the default theme settled, so that the site stays conformant without a manual audit: the contrasts of both palettes measured by numbers with their reference ratios pinned, colour never carrying information alone, targets of 40 px read from the stylesheet for every interactive element, the main content served as text before any island runs, one heading of the first level per page with the table of contents mirroring the sections, the skip link, the focus ring, the tab order and a clickable equivalent to every keyboard shortcut, and the static checker with the contrast measure run by the gallery command over every state of the gallery, the type pages included. Six test files, one per criterion, render the gallery and read the stylesheet; the gallery command fails on any finding, so a theme author runs it after every change. A textual equivalent accompanies every graphical view, and a white label installation inherits the guarantees as long as its theme keeps what they rest on. | 28 |
| Category | category list, list of a folder | A folder of a space as the site lists it: every folder of a repository, at any depth, gets the list of the notes filed under it, at the address a note of that path would take (<source>/<folder>/, <source>/<folder>/<sub>/), and yields to such a note; a space whose every note is dated gets a category per year and per month as well. The cards of the space page, the folders of the tree and the steps of the breadcrumb lead to the categories, which open as pages rather than unfold. A category is named by the title the folders block of its source declares, else by the folder name; its list counts the notes as their type words it and describes the type, or, below the top of the space, says how many pages are filed under the path. | 55 |
| Colour scheme | dark mode, light mode, mode switch | One of the two palettes of a theme, light or dark, in force on a page of the site. The dark palette is a second palette, measured on its own, never an inversion of the light one: its contrasts are checked separately, and it casts no shadow. A page follows the system preference until the reader presses the switch of the bar, which displays the other scheme and remembers the choice in the browser; the switch draws the glyph of the scheme it switches to and is pressed while the dark one is displayed. | 60 |
| Fragment | JSON fragment, entity fragment | The file the build writes next to the model for one entity, under fragments/<id>.json: the note rendered to sanitised HTML, one section per heading, its written links already turned into page links, or the passages of a keyword page. The rendering reads the model and the fragments and nothing else, so concordance render rebuilds the site without cloning a source. A fragment belongs to one entity and never gathers several. An entity another note cites has a second one, fragments/<id>.mentions.json, holding every mention of it; its page carries the first twenty and loads the rest from there. | 65 |
| Island | hydrated island, interactive island | An interactive component of the site served as its static markup inside a <concordance-island> element carrying its props, and mounted again by one small bundle named after a hash of its content, loaded only by the pages that use it. The mentions panel, the search, the contract viewer, the document viewer, the pinned pages and the handles of the side panels are islands; every one a page loads is a classic script so that it runs from a file:// page. Without JavaScript the content stays reachable: the served HTML carries every page in full and an island only adds sorting, filtering, fetching on demand or a viewer. | 72 |
| Legal declaration | legal pages, accessibility statement, legal notice, personal data page | What only the organisation that publishes a site can say, and what the tool therefore never pre-fills: its legal notice, its accessibility statement with the compliance it declares, non compliant, partially compliant or compliant, and its personal data page. The footer of every page shows them under "Declared by the organisation" once the configuration gives their addresses, or once a note filed at legal/<page>.md in a source stands for them, and shows nothing otherwise: the first column of the footer, what the tool knows of the site, is exact and complete on its own. The distinction is the point: a publication date or a licence is a fact the tool holds, an accessibility state is a commitment a human takes. | 7 |
| Passage | quoted passage, context | The words around an occurrence as a page quotes them, eighty characters kept at the scan with the matched words marked: a keyword page lists its passages grouped by file in corpus order, each linked to its line, and the related pages of an entity show one under every citing page, the mention an author wrote when there is one. The passages of a keyword page live in its fragment. | 95 |
| Pinned page | pin, pinned pages, pins | A page of the site a reader chose to keep at hand: pinned from the button after its title, shown as a tab in a row under the bar of every page, in the order of pinning, until the reader removes it. The row exists only once a page is pinned; it holds what fits and folds the rest behind a summary that lists every pin with a filter. The pins live in the browser, never in the address, and never expire on their own: an entity pinned keeps its tab, named by the title read at the time, even once a later publication removed its page. Without JavaScript the row and the button are not there: the served HTML carries every page in full, as the theme renders it. | 58 |
| Related page | related pages, cited page | A page that evokes an entity, as the right panel of that entity's page lists it: its title, its type, the number of passages where the entity is named and one of those passages as an excerpt. The related pages of an entity are ordered by number of passages, a link an author wrote and a recognised word counted alike; a page that writes a link is marked "cited", because a link is what someone asserted and a recognised word what the tool inferred. The block groups the mentions of the entity by citing page, six entries in view before the button naming the others, and can be narrowed by type or by a word once the page's script runs. A page that nothing links to, a keyword page, a meeting or a document, lists instead the pages its own passages evoke. | 64 |
| Side panel | collapsible panel, panel handle | One of the two columns beside the text of a page of the site: the tree of the space on the left, the panel of what the tool computed on the right. On a desk each folds behind a handle on its edge, a tab half slid behind the panel that draws the way the panel goes, to a strip that keeps its name; the room goes to the tables, figures and code of the note while the prose keeps its measure. What a reader folds is remembered by the browser from page to page and never enters the address; without JavaScript every panel stands open. | 41 |
| Site | generated site, site block | What the build writes under dist/ after the model: the home page, one page per entity at the address of its identifier, the alphabetical index, the to-do page, the results page with the search index next to it, and the assets. Every link is relative and every page sits in its own folder as index.html, so the site reads over file:// as behind a server and under any prefix. The site: block of the configuration holds the options of the pages, neighbourhood.size, the number of nodes of the neighbourhood map, six by default and twelve at most. | 168 |
| Slot | named slot, site slot | One of the eleven named parts of the generated site, each with a typed view model that is the contract between the build and a theme: Shell, Header and Footer around every page, then Home, EntityPage, KeywordPage, SearchResults, Index and Todo for the pages, MentionsPanel and Neighbourhood for the panels of an entity page. The default theme implements every slot; a plugin theme replaces any of them with a component receiving the same props, and the slots it does not provide stay default. The gallery renders every slot with fixture data so that a theme is styled without building a corpus. | 58 |
| Space | space of a page, tree of the space | A source as a reader browses it in the generated site: the top bar links to the spaces page, which lists them all with what each holds, its page count and its newest change; every space has a page of its own, <source>/index.html, where the rows of the home page lead, with its categories, the top-level folders of its repository, its latest changes and the words its notes cite most, counted in the space only, under a search field confined to it; the breadcrumb of an entity page starts with its space, and the left column of that page shows the tree of the space, its head leading to the page of the space, its folders with their page counts, each leading to its category, the folder of the page open and the page marked. The tree appears there only, so that nothing has to be unfolded from the home page. A space is named by the title its source declares, its name standing in without one and staying the first segment of every address. | 81 |
| Textual equivalent | text alternative, equivalent list | The structured text that accompanies every graphical view of the site and carries the same information: the list of neighbours right after the neighbourhood map, inside the same section, each entry with its entity, its type as the profile labels it and the nature of the link as the page meets it, the inverse label of a relation that points at the page. It is present in the served HTML, so the search index reads it and a screen reader announces it; the graphic is hidden from assistive technologies, points at the list, and the text is authoritative. | 43 |
| Theme | theme.yaml, site theme | The file that decides how the generated site looks: the name and logo of the site, its favicon, its font families, its corner radius, its light and dark palettes, its footer and an additional stylesheet loaded after the tool's own. The build validates it against the theme schema and reports a faulty key by its path. A plugin may ship a theme of its own, with components replacing parts of the site; the project's file wins over a plugin's. A theme that names the organisation and not the tool is a white label. | 87 |
| White label | white-label installation, unbranded site | A site generated for an organisation that shows the organisation's name, logo, colours and fonts and nothing of the tool that built it. Everything a reader sees comes from the theme; the credit of the tool in the footer is off unless the project turns it on. The project's own wiki turns it on, since the tool is documenting itself. | 28 |
16 site of 16 — pagination by twenty. The Links column counts the related pages, which brings the most central site of the journey to the top.