Neighbourhood map

ScreenSpace Specifications

The small map (49 passages, no note) of the entity page that shows the closest entities at one hop (3 passages, no note), all labelled (3 passages, no note), and never stands alone: a list next to it carries the same information (10 passages, no note) in text. Deliberately modest, six nodes (note: Entity) by default and twelve at most; beyond the cap the map draws (8 passages, no note) the nodes kept and says how many neighbours (42 passages, no note) the page has in total, and a page without any neighbour points at the mentions panel instead.

Today

The map is folded behind the last line of the side panel (note: Side panel), a small network mark before "See the neighbourhood map · n pages", n counting the nodes the map draws. Opening it turns that line into the head of the map, a ◂ back control before the title "Neighbourhood map" and the name of the page; on a desktop (3 passages, no note) the map then takes the place of the other blocks of the panel (97 passages, no note), which widens (3 passages, no note) to hold it, so that the text of the page stays readable beside it and the map never occupies the page. On a phone (10 passages, no note) the map opens in the flow (4 passages, no note) of the page under the blocks, on a tablet (6 passages, no note) at the foot (10 passages, no note) of the page. The fold is a native disclosure (4 passages, no note): it opens without any script (37 passages, no note) and over a local (27 passages, no note) file.

Under its head, the map shows its controls: the distance (6 passages, no note) it is drawn (23 passages, no note) at, "Distance · 1 hop (8 passages, no note)", the one distance the model (note: Model) records, since the neighbourhood (note: Neighbourhood) is computed at build (note: Build) and a second hop is never computed in the browser (31 passages, no note); and "Types (note: Type)", a filter (note: Facet) of checkboxes (3 passages, no note), one per type present in the neighbourhood with its count, served all ticked, that hides the nodes, the edges (10 passages, no note) and the rows (41 passages, no note) of a type unticked. The map sits in a frame (5 passages, no note) on the soft surface (3 passages, no note): the page at its centre (11 passages, no note) is the one node drawn in the accent (23 passages, no note), the current position (23 passages, no note), its neighbours are small grey (3 passages, no note) nodes around it. Under the map, a legend reads "existing page" beside a plain rule (note: Rule) and "word without a note (note: Keyword)" beside a dashed (13 passages, no note) one.

The entity is the centre; its neighbourhood comes from the model, computed at build and never in the browser, in the order the profile (note: Profile) gives: the neighbours stand on a ring (7 passages, no note) around the centre in that order, clockwise from the top. Every node carries its name in plain text next to it, on the outer side of the ring so that names never sit over the edges, and a name longer than twenty-eight characters (16 passages, no note) is cut with an ellipsis (3 passages, no note), the full title staying (5 passages, no note) in the list below. The layout is deterministic (3 passages, no note) and the same labels (44 passages, no note) never overlap: the tool estimates (3 passages, no note) the width of every label, pushes apart any two that would touch, and widens the drawing (4 passages, no note) to hold the longest (3 passages, no note) ones.

The type of a neighbour is told by shape (8 passages, no note) and glyph (10 passages, no note), not by colour (22 passages, no note). A typed entity is a filled circle holding the glyph of its type (3 passages, no note), a shape the theme (note: Theme) maps to the glyph name the profile declares (a hexagon for an API (note: API) or an endpoint (note: Operation), a rectangle for a screen (note: Screen), a shield for a rule, a book for a term (note: Term), and so on) or the initial of the glyph name when the theme has no shape for it. A keyword page, a word without a note, is a hollow dashed square (5 passages, no note), and the edge that leads to it is dashed too. Colour follows the theme and carries nothing on its own.

The map is drawn for at most the configured number of nodes, site.neighbourhood.size, six by default and twelve at most. When the model holds more neighbours than that, the map draws the ones kept and one sentence (25 passages, no note) under it says so, "n neighbours in total, more than the map shows"; the list of those neighbours follows. A page without any neighbour draws no map: the notice (12 passages, no note) "No neighbour recorded" links (note: Link) to the mentions panel, where every citation (note: Mention) is listed. A keyword page carries no link, so its map is drawn from its co-occurrences (note: Co-occurrence): the pages and the other words that accompany it most often, six at most, a page as a full node and a word without a note as a dashed one, each counted by the paragraphs (19 passages, no note) it shares with the word.

The map is hidden from assistive technologies and the list under it, headed "The six neighbours · textual equivalent (note: Textual equivalent)" and closed by the note (note: Note) "Six neighbours at most, always named. Beyond that the map teaches nothing: the list takes over.", is authoritative (4 passages, no note): the same neighbours in the same order, each entry opening on the accent mark and naming the entity (3 passages, no note) by its title, its type as plain text by the label the profile gives it in the site (note: Site) language (40 passages, no note) ("Keyword" for a word without a note), the nature of the link by the relation (note: Relation) label read from the page, so that a screen reads "accesses (4 passages, no note)" and the object (28 passages, no note) it reaches reads "is accessed by", and its passage (note: Passage) count. The figure points at the list, the list is never hidden, and the page writes no wording (4 passages, no note) of its own into it: what the profile and the project (note: Project)'s labels say reaches the reader (note: Reader) unchanged. The list is plain text in the served HTML, where the search index (note: Search index) reads it with the rest of the page, so a neighbour found there leads to the page as any other word does.

Objects

Actions

  1. Unfold the map from the line of the panel, fold it back with the ◂ control
  2. Hide the neighbours of a type from the "Types" filter
  3. Open a neighbour → entity page
  4. Open a noteless word → keyword page
  5. Without any neighbour, see every citation → mentions panel

Rules

Properties5

Application
Generated site
Status
valid
Roles
Reader
URL pattern
/{source}/{path}#neighbourhood-title

5 declared keys. The rest of the file is free text.

On this page4

  1. Today
  2. Objects
  3. Actions
  4. Rules
See the neighbourhood map6 pages6Neighbourhood mapNeighbourhood map

Neighbourhood map Neighbourhood map

Distance1 hop

Neighbourhood map. The list below carries the same information as the map.existing pageword without a note

93 neighbours in total, more than the map shows.

textual equivalent

Six neighbours at most, always named. Beyond that the map teaches nothing: the list takes over.