wiki-plugin-pod 1.0.0 → 1.2.2

package/pages/about-pod-plugin

@@ -14,22 +14,37 @@
     {
       "type": "markdown",
       "id": "625ddc4e896c6e27",
-      "text": "Write one **command** per line (UPPERCASE, an optional trailing colon \u2014 see the [[Fedwiki DSL Skill]] convention):\n\n- `POD` \u2014 `PARENT` and `SISTERS` together (shorthand)\n- `SISTERS` \u2014 sibling sites sharing the parent domain\n- `PARENT` \u2014 the parent-domain site itself\n- `CHILDREN` \u2014 direct sub-domains of this site\n- `DESCENDANTS` \u2014 all sub-domains, any depth\n- `FARM` \u2014 every wiki in the farm\n- `NEIGHBOURHOOD` \u2014 the sites currently in your neighborhood\n- `SNAPSHOT` \u2014 the current neighborhood *(same as NEIGHBOURHOOD)*\n\nAnd the **actions** (not site-kinds):\n\n- `ROSTER` \u2014 draw the gather compactly, mirroring a normal roster item\n- `TWIN` \u2014 only members that hold a page with **this page's slug**\n- `WATCH` \u2014 only members whose copy is *actually a fork* of it\n- `TITLE yes|no` \u2014 whether the `ROSTER` title shows (default yes)"
+      "text": "Write one **command** per line (UPPERCASE, an optional trailing colon \u2014 see the [[Fedwiki DSL Skill]] convention):\n\n- `POD` \u2014 `PARENT` and `SISTERS` together (shorthand)\n- `SISTERS` \u2014 sibling sites sharing the parent domain\n- `PARENT` \u2014 the parent-domain site itself\n- `CHILDREN` \u2014 direct sub-domains of this site\n- `DESCENDANTS` \u2014 all sub-domains, any depth\n- `FARM` \u2014 every wiki in the farm\n- `NEIGHBOURHOOD` \u2014 the sites currently in your neighborhood\n- `SNAPSHOT` \u2014 the current neighborhood *(same as NEIGHBOURHOOD)*\n\nAnd one drawing choice:\n\n- `TITLE yes|no` \u2014 whether each group shows its heading (default yes)"
+    },
+    {
+      "type": "markdown",
+      "id": "4161c30927bd",
+      "text": "### Mistyped commands\n\nA misspelled command is not silently swallowed. `CHIKDREN` names nothing, so the item would otherwise fall back to `SISTERS` and draw a pod nobody asked for. Instead the panel says *CHIKDREN \u2014 did you mean CHILDREN?* above the gather, in every display mode. A word that announces itself as a command \u2014 uppercase, the [[Fedwiki DSL Skill]] convention \u2014 but names none is always reported, even when no real command is close enough to guess. Ordinary lowercase prose stays data."
     },
     {
       "type": "markdown",
       "id": "7c1a4e0b9f2d5a86",
-      "text": "### ROSTER, TWIN and WATCH \u2014 compact rosters of flags\n\nAll three render like a **roster item**: the members' flags flow inline in the grey box, each linking to that member's copy of the page, the (sub)domain on hover. `ROSTER` shows the whole gather (mirroring a normal roster, with an optional left-aligned title toggled by `TITLE yes|no`); `TWIN`/`WATCH` filter it:\n\n- **`TWIN`** is **existence-only** \u2014 a slug match in the member's sitemap, like the wiki-client *Twins* strip.\n- **`WATCH`** is **lineage-aware** \u2014 it fetches each twin's page JSON and keeps only those whose journal carries a `fork` event (`WATCH \u2286 TWIN`): who is watching your page.\n\nThe `ROSTER` and table views carry a subtle **\u2744 icon** that saves the gather as a roster ghost page titled after the commands (e.g. `PARENT SISTERS Rosters`). No separate `FREEZE` command.\n\n```\nSISTERS\nWATCH\n```"
+      "text": "### How it draws\n\nEvery pod is a **roster**: a heading, then the members' flags. Pod does not draw it \u2014 the [[Roster Plugin]] does, on every wiki there is, so pod builds the roster text and hands it over. The text it builds is exactly what the \u2744 icon saves as a page, so the drawn thing and the saved thing are one string.\n\nEach heading names the site the pod is relative to \u2014 *Sisters of fedwiki.club*, *The rest of the farm*, *Your neighbourhood*. `TITLE no` draws the flags with no headings at all."
+    },
+    {
+      "type": "markdown",
+      "id": "775aabdf4879ebab",
+      "text": "### Retired commands\n\n`ROSTER`, `TWIN` and `WATCH` stay in the table rather than being deleted, because a word removed from the table is a word the parser reports as a mistake \u2014 and pages still say them. They parse, gather nothing, and say what became of them.\n\n`ROSTER` is the default now. `TWIN` and `WATCH` moved to the [[Twin Plugin]], which asks who holds *this page* rather than who is kin to *this site*."
     },
     {
       "type": "markdown",
       "id": "cedff82dadcf82fd",
       "text": "Each gathered site is registered as a neighbor, so its pages join your search and lineage. The page still reads normally without the plugin."
     },
+    {
+      "type": "markdown",
+      "id": "9bebcef374d5",
+      "text": "### Where a pod comes from\n\nThis plugin ships **no server**. It declares a specification and a module of plain functions, and the [[Farm Plugin]] mounts them \u2014 so the item reads its disk-derived pods from `/system/api/pod/roll.json`, the same address an agent uses. Kinship is arithmetic on names, and the only thing needing the disk is what sites exist: one directory read, no page counts.\n\n`NEIGHBOURHOOD` and `SNAPSHOT` ask nothing at all \u2014 they read the neighbourhood the browser has already assembled. Page counts and freshness come from each member's own sitemap.\n\nA wiki without the Farm Plugin says so in the panel instead of failing quietly; the requirement is declared in `fedwiki.requires`."
+    },
     {
       "type": "markdown",
       "id": "c41e9b70a5d8362f",
-      "text": "# Which Commands Cross\n\nA command language is a superset of an interface, never a mirror of one. Of the thirteen words below, five become a value of the `kinds` parameter and one is shorthand for two of those; the rest never leave the browser \u2014 `ROSTER` and `TITLE` because they are drawing choices the farm has no opinion about, and `NEIGHBOURHOOD`, `SNAPSHOT`, `TWIN` and `WATCH` because they read what only a browser holds. That last group is not a gap to be closed: no server could answer them however this plugin were written.\n\nThe table saying which is which lives in one module. The parser imports it and the plugin's interface declaration names it, so what an author may type and what the mounted operation accepts are one list read twice. See [[Pod API]] for the rendered version, and [[About Farm Plugin]] for how a declaration becomes a route."
+      "text": "# Which Commands Cross\n\nA command language is a superset of an interface, never a mirror of one. Of the thirteen words in the table, five become a value of the `kinds` parameter and one is shorthand for two of those; the rest never leave the browser \u2014 `TITLE` because it is a drawing choice the farm has no opinion about, `NEIGHBOURHOOD` and `SNAPSHOT` because they read what only a browser holds, and `ROSTER`, `TWIN` and `WATCH` because they are retired and answer nothing. That second group is not a gap to be closed: no server could answer them however this plugin were written.\n\nThe table saying which is which lives in one module, `src/pod/commands.js` \u2014 data with no imports, because the [[Farm Plugin]] loads it server-side. The parser that reads it is `@fortyfoxes/wiki-dsl`, shared with every other plugin whose item text is a small language."
     },
     {
       "type": "markdown",
@@ -39,7 +54,7 @@
     {
       "type": "markdown",
       "id": "19d5c8a03e6b7412",
-      "text": "# See\n\n[[Pod API]] \u00b7 [[Farm API]] \u00b7 [[About Farm Plugin]] \u00b7 [[Fedwiki DSL Skill]]"
+      "text": "# See\n\n[[Twin Plugin]] \u00b7 [[Roster Plugin]] \u00b7 [[Pod API]] \u00b7 [[Farm API]] \u00b7 [[About Farm Plugin]] \u00b7 [[Fedwiki DSL Skill]]"
     }
   ],
   "journal": [
@@ -151,7 +166,90 @@
         "text": "### ROSTER, TWIN and WATCH \u2014 compact rosters of flags\n\nAll three render like a **roster item**: the members' flags flow inline in the grey box, each linking to that member's copy of the page, the (sub)domain on hover. `ROSTER` shows the whole gather (mirroring a normal roster, with an optional left-aligned title toggled by `TITLE yes|no`); `TWIN`/`WATCH` filter it:\n\n- **`TWIN`** is **existence-only** \u2014 a slug match in the member's sitemap, like the wiki-client *Twins* strip.\n- **`WATCH`** is **lineage-aware** \u2014 it fetches each twin's page JSON and keeps only those whose journal carries a `fork` event (`WATCH \u2286 TWIN`): who is watching your page.\n\nThe `ROSTER` and table views carry a subtle **\u2744 icon** that saves the gather as a roster ghost page titled after the commands (e.g. `PARENT SISTERS Rosters`). No separate `FREEZE` command.\n\n```\nSISTERS\nWATCH\n```"
       },
       "date": 1784400000000
+    },
+    {
+      "type": "add",
+      "id": "4161c30927bd",
+      "item": {
+        "type": "markdown",
+        "id": "4161c30927bd",
+        "text": "### Mistyped commands\n\nA misspelled command is not silently swallowed. `CHIKDREN` names nothing, so the item would otherwise fall back to `SISTERS` and draw a pod nobody asked for. Instead the panel says *CHIKDREN \u2014 did you mean CHILDREN?* above the gather, in every display mode. A word that announces itself as a command \u2014 uppercase, the [[Fedwiki DSL Skill]] convention \u2014 but names none is always reported, even when no real command is close enough to guess. Ordinary lowercase prose stays data."
+      },
+      "after": "625ddc4e896c6e27",
+      "date": 1757000000000
+    },
+    {
+      "type": "add",
+      "id": "9bebcef374d5",
+      "item": {
+        "type": "markdown",
+        "id": "9bebcef374d5",
+        "text": "### Where a pod comes from\n\nKinship is arithmetic on names, so the farm is asked only what sites exist \u2014 `GET /plugin/pod/sites` \u2014 and the browser sorts that list into sisters, parent, children, descendants and farm itself. The same module does the sorting for the mounted API operation, so an agent and a reader get one answer from one implementation.\n\n`NEIGHBOURHOOD` and `SNAPSHOT` ask the farm nothing at all: they read the neighbourhood the browser has already assembled. Page counts and freshness come from each member's own sitemap, which the browser holds anyway."
+      },
+      "after": "cedff82dadcf82fd",
+      "date": 1757260000000
+    },
+    {
+      "type": "edit",
+      "id": "9bebcef374d5",
+      "item": {
+        "type": "markdown",
+        "id": "9bebcef374d5",
+        "text": "### Where a pod comes from\n\nThis plugin ships **no server**. It declares a specification and a module of plain functions, and the [[Farm Plugin]] mounts them \u2014 so the item reads its disk-derived pods from `/system/api/pod/roll.json`, the same address an agent uses. Kinship is arithmetic on names, and the only thing needing the disk is what sites exist: one directory read, no page counts.\n\n`NEIGHBOURHOOD` and `SNAPSHOT` ask nothing at all \u2014 they read the neighbourhood the browser has already assembled. Page counts and freshness come from each member's own sitemap.\n\nA wiki without the Farm Plugin says so in the panel instead of failing quietly; the requirement is declared in `fedwiki.requires`."
+      },
+      "date": 1757262000000
+    },
+    {
+      "type": "edit",
+      "id": "7c1a4e0b9f2d5a86",
+      "item": {
+        "type": "markdown",
+        "id": "7c1a4e0b9f2d5a86",
+        "text": "### How it draws\n\nEvery pod is a **roster**: a heading, then the members' flags. Pod does not draw it \u2014 the [[Roster Plugin]] does, on every wiki there is, so pod builds the roster text and hands it over. The text it builds is exactly what the \u2744 icon saves as a page, so the drawn thing and the saved thing are one string.\n\nEach heading names the site the pod is relative to \u2014 *Sisters of fedwiki.club*, *The rest of the farm*, *Your neighbourhood*. `TITLE no` draws the flags with no headings at all."
+      },
+      "date": 1788799155315
+    },
+    {
+      "type": "add",
+      "id": "775aabdf4879ebab",
+      "item": {
+        "type": "markdown",
+        "id": "775aabdf4879ebab",
+        "text": "### Retired commands\n\n`ROSTER`, `TWIN` and `WATCH` stay in the table rather than being deleted, because a word removed from the table is a word the parser reports as a mistake \u2014 and pages still say them. They parse, gather nothing, and say what became of them.\n\n`ROSTER` is the default now. `TWIN` and `WATCH` moved to the [[Twin Plugin]], which asks who holds *this page* rather than who is kin to *this site*."
+      },
+      "after": "7c1a4e0b9f2d5a86",
+      "date": 1788799155315
+    },
+    {
+      "type": "edit",
+      "id": "19d5c8a03e6b7412",
+      "item": {
+        "type": "markdown",
+        "id": "19d5c8a03e6b7412",
+        "text": "# See\n\n[[Twin Plugin]] \u00b7 [[Roster Plugin]] \u00b7 [[Pod API]] \u00b7 [[Farm API]] \u00b7 [[About Farm Plugin]] \u00b7 [[Fedwiki DSL Skill]]"
+      },
+      "date": 1788799155315
+    },
+    {
+      "type": "edit",
+      "id": "625ddc4e896c6e27",
+      "item": {
+        "type": "markdown",
+        "id": "625ddc4e896c6e27",
+        "text": "Write one **command** per line (UPPERCASE, an optional trailing colon \u2014 see the [[Fedwiki DSL Skill]] convention):\n\n- `POD` \u2014 `PARENT` and `SISTERS` together (shorthand)\n- `SISTERS` \u2014 sibling sites sharing the parent domain\n- `PARENT` \u2014 the parent-domain site itself\n- `CHILDREN` \u2014 direct sub-domains of this site\n- `DESCENDANTS` \u2014 all sub-domains, any depth\n- `FARM` \u2014 every wiki in the farm\n- `NEIGHBOURHOOD` \u2014 the sites currently in your neighborhood\n- `SNAPSHOT` \u2014 the current neighborhood *(same as NEIGHBOURHOOD)*\n\nAnd one drawing choice:\n\n- `TITLE yes|no` \u2014 whether each group shows its heading (default yes)"
+      },
+      "date": 1788801820003
+    },
+    {
+      "type": "edit",
+      "id": "c41e9b70a5d8362f",
+      "item": {
+        "type": "markdown",
+        "id": "c41e9b70a5d8362f",
+        "text": "# Which Commands Cross\n\nA command language is a superset of an interface, never a mirror of one. Of the thirteen words in the table, five become a value of the `kinds` parameter and one is shorthand for two of those; the rest never leave the browser \u2014 `TITLE` because it is a drawing choice the farm has no opinion about, `NEIGHBOURHOOD` and `SNAPSHOT` because they read what only a browser holds, and `ROSTER`, `TWIN` and `WATCH` because they are retired and answer nothing. That second group is not a gap to be closed: no server could answer them however this plugin were written.\n\nThe table saying which is which lives in one module, `src/pod/commands.js` \u2014 data with no imports, because the [[Farm Plugin]] loads it server-side. The parser that reads it is `@fortyfoxes/wiki-dsl`, shared with every other plugin whose item text is a small language."
+      },
+      "date": 1788801820003
     }
   ],
   "plugin": "pod"
-}
+}