@rse/specbook 1.2.11 → 1.2.13

package/dst/specbook-export-html.css

@@ -282,7 +282,9 @@ body.info-on div.info-switch svg.info-icon {
     icon leading each, the kinds bold in the path color and the names
     semi-bold in the description color, as in the document content,
     and a pointer separating the segments), extended for properties
-    with the not-filled circle icon and the bold property name, and
+    with the not-filled circle icon and the bold property name, trailed
+    for instances by the anchor id of the object in the description
+    color (its "(#...)" wrapping normal, the id itself semi-bold), and
     the description led by a "Schema" or "Specification" origin label
     (its word in normal weight in a rounded box filled with the path
     color), where
@@ -329,6 +331,13 @@ div.info-popup span.info-name {
 div.info-popup.spec span.info-name {
   color: var(--theme-color-specbook-popup-spec-desc);
 }
+div.info-popup.spec span.info-id {
+  color: var(--theme-color-specbook-popup-spec-desc);
+  font-weight: normal;
+}
+div.info-popup.spec span.info-id-name {
+  font-weight: 600;
+}
 div.info-popup span.info-object::before {
   content: "\25CF";
   font-weight: normal;

package/dst/specbook-export-html.js

@@ -109,7 +109,7 @@ const templates = {
             <h1>Table of Contents</h1>
             <table>
                 {% for entry in Toc.entries %}
-                <tr class="level-{{ entry.level }}"><td><a href="#{{ entry.id }}"><span class="object-kind"{% if entry.info %} data-info="{{ entry.info }}" data-info-path="{{ entry.infopath }}"{% endif %}>{{ entry.kind }}:</span> <span class="object-name"{% if entry.spec %} data-info-spec="{{ entry.spec }}" data-info-path="{{ entry.specpath }}"{% endif %}>{{ entry.name }}</span> <span class="link-symbol">&#x26AD;</span></a></td>{% if entry.page %}<td class="page"><a href="#{{ entry.id }}">{{ entry.page }}</a></td>{% endif %}</tr>
+                <tr class="level-{{ entry.level }}"><td><a href="#{{ entry.id }}"><span class="object-kind"{% if entry.info %} data-info="{{ entry.info }}" data-info-path="{{ entry.infopath }}"{% endif %}>{{ entry.kind }}:</span> <span class="object-name"{% if entry.spec %} data-info-spec="{{ entry.spec }}" data-info-id="{{ entry.specid }}" data-info-path="{{ entry.specpath }}"{% endif %}>{{ entry.name }}</span> <span class="link-symbol">&#x26AD;</span></a></td>{% if entry.page %}<td class="page"><a href="#{{ entry.id }}">{{ entry.page }}</a></td>{% endif %}</tr>
                 {% endfor %}
             </table>
         </nav>
@@ -132,7 +132,7 @@ const templates = {
     "TocPanelEntries": textframe `
         <ul>
             {% for entry in Entries %}
-            <li><a href="#{{ entry.id }}"><span class="entry"><span class="object-kind"{% if entry.info %} data-info="{{ entry.info }}" data-info-path="{{ entry.infopath }}"{% endif %}>{{ entry.kind }}:</span> <span class="object-name"{% if entry.spec %} data-info-spec="{{ entry.spec }}" data-info-path="{{ entry.specpath }}"{% endif %}>{{ entry.name }}</span></span></a>{{ entry.children }}</li>
+            <li><a href="#{{ entry.id }}"><span class="entry"><span class="object-kind"{% if entry.info %} data-info="{{ entry.info }}" data-info-path="{{ entry.infopath }}"{% endif %}>{{ entry.kind }}:</span> <span class="object-name"{% if entry.spec %} data-info-spec="{{ entry.spec }}" data-info-id="{{ entry.specid }}" data-info-path="{{ entry.specpath }}"{% endif %}>{{ entry.name }}</span></span></a>{{ entry.children }}</li>
             {% endfor %}
         </ul>
     `,
@@ -152,7 +152,7 @@ const templates = {
     /*  <Object/>  */
     "Object": textframe `
         <section>
-            <h{{ Object.level }} id="{{ Object.id }}"{% if Object.anchor %} data-id="{{ Object.anchor }}"{% endif %}><span class="object-kind"{% if Object.info %} data-info="{{ Object.info }}" data-info-path="{{ Object.infopath }}"{% endif %}>{{ Object.kind }}:</span> <span class="object-name"{% if Object.spec %} data-info-spec="{{ Object.spec }}" data-info-path="{{ Object.specpath }}"{% endif %}>{{ Object.name }}</span>{% if Object.primary %} <span class="primary-marker">&#x2318;</span>{% endif %}{% if Object.paren %} <span class="anchor-paren">({{ Object.paren }})</span>{% endif %} <a href="#{{ Object.id }}"><span class="anchor-symbol">&#x2693;&#xFE0E;</span></a></h{{ Object.level }}>
+            <h{{ Object.level }} id="{{ Object.id }}"{% if Object.anchor %} data-id="{{ Object.anchor }}"{% endif %}><span class="object-kind"{% if Object.info %} data-info="{{ Object.info }}" data-info-path="{{ Object.infopath }}"{% endif %}>{{ Object.kind }}:</span> <span class="object-name"{% if Object.spec %} data-info-spec="{{ Object.spec }}" data-info-id="{{ Object.specid }}" data-info-path="{{ Object.specpath }}"{% endif %}>{{ Object.name }}</span>{% if Object.primary %} <span class="primary-marker">&#x2318;</span>{% endif %}{% if Object.paren %} <span class="anchor-paren">({{ Object.paren }})</span>{% endif %} <a href="#{{ Object.id }}"><span class="anchor-symbol">&#x2693;&#xFE0E;</span></a></h{{ Object.level }}>
             {{ Object.diagram }}
             {{ Object.properties }}
             {{ Object.description }}
@@ -207,7 +207,7 @@ const templates = {
             <tbody>
                 {% for row in Table.rows %}
                 <tr id="{{ row.id }}"{% if row.anchor %} data-id="{{ row.anchor }}"{% endif %}{% if row.even %} class="even"{% endif %}>
-                    <td><span{% if row.spec %} data-info-spec="{{ row.spec }}" data-info-path="{{ row.specpath }}"{% endif %}>{{ row.name }}</span>{% if row.primary %} <span class="primary-marker">&#x2318;</span>{% endif %}{% if row.paren %} <span class="anchor-paren">({{ row.paren }})</span>{% endif %} <a href="#{{ row.id }}"><span class="anchor-symbol">&#x2693;&#xFE0E;</span></a></td>
+                    <td><span{% if row.spec %} data-info-spec="{{ row.spec }}" data-info-id="{{ row.specid }}" data-info-path="{{ row.specpath }}"{% endif %}>{{ row.name }}</span>{% if row.primary %} <span class="primary-marker">&#x2318;</span>{% endif %}{% if row.paren %} <span class="anchor-paren">({{ row.paren }})</span>{% endif %} <a href="#{{ row.id }}"><span class="anchor-symbol">&#x2693;&#xFE0E;</span></a></td>
                     {%- for value in row.values %}<td>{{ value }}</td>{% endfor %}
                     {%- if Table.desc %}<td>{{ row.description }}</td>{% endif %}
                 </tr>
@@ -227,7 +227,7 @@ const templates = {
             <tbody>
                 {% for row in Table.rows %}
                 <tr id="{{ row.id }}"{% if row.anchor %} data-id="{{ row.anchor }}"{% endif %}{% if row.even %} class="even"{% endif %}>
-                    <td><span{% if row.spec %} data-info-spec="{{ row.spec }}" data-info-path="{{ row.specpath }}"{% endif %}>{{ row.name }}</span>{% if row.primary %} <span class="primary-marker">&#x2318;</span>{% endif %}{% if row.paren %} <span class="anchor-paren">({{ row.paren }})</span>{% endif %} <a href="#{{ row.id }}"><span class="anchor-symbol">&#x2693;&#xFE0E;</span></a></td>
+                    <td><span{% if row.spec %} data-info-spec="{{ row.spec }}" data-info-id="{{ row.specid }}" data-info-path="{{ row.specpath }}"{% endif %}>{{ row.name }}</span>{% if row.primary %} <span class="primary-marker">&#x2318;</span>{% endif %}{% if row.paren %} <span class="anchor-paren">({{ row.paren }})</span>{% endif %} <a href="#{{ row.id }}"><span class="anchor-symbol">&#x2693;&#xFE0E;</span></a></td>
                     <td class="chunks">
                         <table class="chunks">
                             {% for chunk in row.chunks %}
@@ -866,7 +866,8 @@ const tocPanelScript = textframe `
     carrying a "data-info-spec" key pops up the corpus description of
     the object instance (a diagram node box resolves through its
     hyperlinked object anchor), titled with the "data-info-path" object
-    path and fed from the injected INFO/SPEC maps of pre-rendered
+    path (an instance popup trailing the "data-info-id" anchor id of
+    the object) and fed from the injected INFO/SPEC maps of pre-rendered
     description HTML; the popup is capped at 40% viewport width and
     attached above or below, whichever side offers more space; the
     script runs at the end of the body, so a live preview body swap
@@ -964,6 +965,20 @@ const infoPopupScript = textframe `
                 }
                 title.appendChild(path)
             }
+
+            /*  the anchor id of an object instance (explicit or derived
+                from its name, carried by the "data-info-id" key) trails
+                the last segment  */
+            const anchor = source.getAttribute("data-info-id")
+            if (spec !== null && anchor !== null) {
+                const id = document.createElement("span")
+                id.className = "info-id"
+                const name = document.createElement("span")
+                name.className = "info-id-name"
+                name.textContent = anchor
+                id.append(" (#", name, ")")
+                title.appendChild(id)
+            }
             if (prop !== null) {
                 title.appendChild(pointer())
                 const name = document.createElement("span")
@@ -1154,11 +1169,12 @@ const infoAttr = (object) => {
         ` data-info="${escapeHtml(key)}" data-info-path="${escapeHtml(infoPathOf(object, false))}"` : "";
 };
 /*  render the corpus description popup key (the fully-qualified anchor
-    path) and name-ending title path of an object as "data-info-spec"
-    attributes for the manually assembled hyperlink markup (the
+    path), anchor id, and name-ending title path of an object as
+    "data-info-spec" attributes for the manually assembled hyperlink markup (the
     instance popup of the compact and full hyperlinks)  */
 const specAttr = (object) => infoParents !== null ?
-    ` data-info-spec="${escapeHtml(anchorOf(object))}" data-info-path="${escapeHtml(infoPathOf(object))}"` : "";
+    ` data-info-spec="${escapeHtml(anchorOf(object))}" data-info-id="${escapeHtml(object.id)}"` +
+        ` data-info-path="${escapeHtml(infoPathOf(object))}"` : "";
 /*  collect the description popup map and the qualified title paths of
     the schema nodes (the artifact kind leading its name, the nested
     kinds appended), with the description Markdown of the objects and
@@ -1464,6 +1480,7 @@ const renderTable = (children, maxColumns) => {
                     paren: child.paren,
                     primary: child.primary,
                     spec: infoParents !== null ? anchorOf(child) : undefined,
+                    specid: child.id,
                     specpath: infoPathOf(child),
                     name: inline(child.name),
                     even: i % 2 === 1,
@@ -1505,6 +1522,7 @@ const renderTable = (children, maxColumns) => {
                     paren: child.paren,
                     primary: child.primary,
                     spec: infoParents !== null ? anchorOf(child) : undefined,
+                    specid: child.id,
                     specpath: infoPathOf(child),
                     name: inline(child.name),
                     even: i % 2 === 1,
@@ -1522,6 +1540,7 @@ const renderObject = (object, level, concise) => {
             info: infoKeyOf(object),
             infopath: infoPathOf(object, false),
             spec: infoParents !== null ? anchorOf(object) : undefined,
+            specid: object.id,
             specpath: infoPathOf(object),
             id: anchorOf(object),
             anchor: object.anchor,
@@ -1593,7 +1612,7 @@ const tocEntries = (objects, pages) => {
             const id = anchorOf(object);
             entries.push({ id, kind: object.kind,
                 info: infoKeyOf(object), infopath: infoPathOf(object, false),
-                spec: infoParents !== null ? id : undefined, specpath: infoPathOf(object),
+                spec: infoParents !== null ? id : undefined, specid: object.id, specpath: infoPathOf(object),
                 name: inline(object.name), level: Math.min(level, 6), page: pages?.get(id) });
             collect(headingChildren(object), level + 1);
         }
@@ -1613,6 +1632,7 @@ const renderTocPanel = (objects, title, doc) => {
             info: infoKeyOf(object),
             infopath: infoPathOf(object, false),
             spec: infoParents !== null ? anchorOf(object) : undefined,
+            specid: object.id,
             specpath: infoPathOf(object),
             name: inline(object.name),
             children: safe(entries(headingChildren(object)))

package/dst/specbook-format.yaml

@@ -151,7 +151,7 @@
             optional: true
         -   name: THEME-STYLE
             desc: The theme style.
-            value: enum(dark,light)
+            value: enum(Dark,Light)
             optional: true
         -   name: THEME-TONE
             desc: The theme color tone.
@@ -347,7 +347,8 @@
             diagram:
                 type: hub
                 center: self
-                nodes: "[[TERM:*]], [[PREMISE:*]], [[RULE:*]], [[DM.ENTITY:*]], [[ROLE:*]], [[PERSONA:*]]"
+                nodes: "[[TERM:*]], [[PREMISE:*]], [[RULE:*]], [[DM.ENTITY:*]], [[ROLE:*]], [[PERSONA:*]],
+                    [[WORKFLOW:*]], [[CONVENTION:*]], [[CV.ENTITY:*]]"
                 labeled: true
                 qualified: true
                 config:
@@ -441,8 +442,8 @@
             diagram:
                 type: hub
                 center: self
-                nodes: "[[ROLE:*]], [[TERM:*]], [[PERSONA:*]], [[ACTIVITY:*]], [[USE-CASE:*]],
-                    [[CV.ENTITY:*]]"
+                nodes: "[[ROLE:*]], [[TERM:*]], [[PERSONA:*]], [[WORKFLOW:*]], [[ACTIVITY:*]],
+                    [[USE-CASE:*]], [[TRANSITION:*]], [[CV.ENTITY:*]]"
                 labeled: true
                 qualified: true
                 config:
@@ -494,8 +495,8 @@
                     optional: true
                 -   name: GENDER
                     desc: >
-                        The gender of the persona: `male`, `female`, or `diverse`.
-                    value: enum(male,female,diverse)
+                        The gender of the persona: `Male`, `Female`, or `Diverse`.
+                    value: enum(Male,Female,Diverse)
                     optional: true
                 -   name: AGE
                     desc: >
@@ -519,9 +520,9 @@
                     optional: true
                 -   name: PROFICIENCY
                     desc: >
-                        The technical and domain skill level of the persona: `novice`,
-                        `intermediate`, or `expert`.
-                    value: enum(novice,intermediate,expert)
+                        The technical and domain skill level of the persona: `Novice`,
+                        `Intermediate`, or `Expert`.
+                    value: enum(Novice,Intermediate,Expert)
                     optional: true
                 -   name: GOAL
                     desc: >
@@ -1099,8 +1100,9 @@
                 type: hub
                 center: self
                 nodes: "[[USE-CASE:*]], [[ROLE:*]], [[PERSONA:*]], [[STEP:*]], [[ACTIVITY:*]],
-                    [[FR.REQUIREMENT:*]], [[RULE:*]], [[TRANSITION:*]], [[PERMISSION:*]],
-                    [[PRINCIPLE:*]], [[CV.ENTITY:*]]"
+                    [[FR.REQUIREMENT:*]], [[RULE:*]], [[DM.ENTITY:*]], [[TRANSITION:*]],
+                    [[PERMISSION:*]], [[PRINCIPLE:*]], [[STORYBOARD:*]], [[CV.ENTITY:*]],
+                    [[TEST-CASE:*]]"
                 labeled: true
                 qualified: true
                 config:
@@ -1269,7 +1271,8 @@
             diagram:
                 type: hub
                 center: self
-                nodes: "[[DM.ENTITY:*]], [[FR.REQUIREMENT:*]], [[USE-CASE:*]]"
+                nodes: "[[DM.ENTITY:*]], [[FR.REQUIREMENT:*]], [[USE-CASE:*]], [[LIFECYCLE:*]],
+                    [[FV.COMPONENT:*]], [[CONCERN:*]], [[TACTIC:*]], [[DECISION:*]], [[TEST-CASE:*]]"
                 edges: "[[RELATION:*]]"
                 labeled: true
                 qualified: true
@@ -1374,18 +1377,21 @@
                         attributes (an "association class") is reified as an entity of its own,
                         related from both sides.
                     optional: true
+                    format:
+                        maxTableColumns: 5
                     props:
                         -   name: TARGET
                             desc: Reference to the DATA-MODEL entity the directed relation targets.
                             value: "[[DM.ENTITY:*]]"
                         -   name: KIND
                             desc: >
-                                The kind of the directed relation: `association` for a plain
-                                reference to an independent target entity, `aggregation` for a
-                                shared part-of relation whose target outlives the entity, or
-                                `composition` for an exclusive part-of relation whose target is
-                                owned by and deleted with the entity; defaults to `association`.
-                            value: enum(association,aggregation,composition)
+                                The kind of the directed relation: `Association` for a plain
+                                reference to an independent target entity, `Aggregation` for a
+                                (optionally even shared) part-of relation whose target outlives
+                                the entity, or `Composition` for an exclusive part-of relation
+                                whose target is owned by and deleted with the entity; defaults to
+                                `Association`.
+                            value: enum(Association,Aggregation,Composition)
                             optional: true
                         -   name: ARITY
                             desc: >
@@ -1693,7 +1699,7 @@
             diagram:
                 type: hub
                 center: self
-                nodes: "[[INTERFACE:*]], [[TYPE:*]], [[ENDPOINT:*]]"
+                nodes: "[[INTERFACE:*]], [[TYPE:*]], [[ENDPOINT:*]], [[FV.COMPONENT:*]]"
                 labeled: true
                 qualified: true
                 config:
@@ -1778,7 +1784,7 @@
             diagram:
                 type: hub
                 center: self
-                nodes: "[[TYPE:*]], [[INTERFACE:*]]"
+                nodes: "[[TYPE:*]], [[INTERFACE:*]], [[ENDPOINT:*]]"
                 deep: true
                 labeled: true
                 qualified: true
@@ -2183,7 +2189,8 @@
             diagram:
                 type: hub
                 center: self
-                nodes: "[[PRINCIPLE:*]], [[PERSONA:*]], [[STEP:*]], [[USE-CASE:*]], [[PATTERN:*]]"
+                nodes: "[[PRINCIPLE:*]], [[PERSONA:*]], [[STEP:*]], [[USE-CASE:*]], [[CONVENTION:*]],
+                    [[PATTERN:*]], [[ELEMENT:*]], [[DECISION:*]]"
                 labeled: true
                 qualified: true
                 config:
@@ -2350,7 +2357,7 @@
             diagram:
                 type: hub
                 center: self
-                nodes: "[[PATTERN:*]], [[PRINCIPLE:*]], [[STORYBOARD:*]]"
+                nodes: "[[PATTERN:*]], [[PRINCIPLE:*]], [[STORYBOARD:*]], [[DECISION:*]]"
                 deep: true
                 labeled: true
                 qualified: true
@@ -2440,7 +2447,7 @@
             diagram:
                 type: hub
                 center: self
-                nodes: "[[STORYBOARD:*]], [[PERSONA:*]], [[SCENARIO:*]], [[PATTERN:*]]"
+                nodes: "[[STORYBOARD:*]], [[PERSONA:*]], [[SCENARIO:*]], [[PATTERN:*]], [[MOCKUP:*]]"
                 deep: true
                 labeled: true
                 qualified: true
@@ -2803,7 +2810,7 @@
                 type: hub
                 center: self
                 nodes: "[[FV.COMPONENT:*]], [[FR.REQUIREMENT:*]], [[INTERFACE:*]], [[DM.ENTITY:*]],
-                    [[TACTIC:*]], [[DECISION:*]]"
+                    [[UNIT:*]], [[NODE:*]], [[CONCERN:*]], [[TACTIC:*]], [[DECISION:*]]"
                 labeled: true
                 qualified: true
                 properties:
@@ -2918,6 +2925,7 @@
             diagram:
                 type: hub
                 center: self
+                nodes: "[[TS.TIER:*]], [[TS.TIER:*.COMPONENT:*]], [[DV.TIER:*]]"
                 hierarchy: true
                 properties:
                     -   PRODUCT
@@ -2942,8 +2950,8 @@
                     diagram:
                         type: hub
                         center: self
-                        nodes: "[[TS.TIER:*.COMPONENT:*]], [[FV.COMPONENT:*]], [[TACTIC:*]],
-                            [[DECISION:*]]"
+                        nodes: "[[TS.TIER:*.COMPONENT:*]], [[FV.COMPONENT:*]], [[CONCERN:*]],
+                            [[TACTIC:*]], [[DECISION:*]]"
                         labeled: true
                         qualified: true
                         properties:
@@ -3512,7 +3520,7 @@
                 type: hub
                 center: self
                 nodes: "[[DV.TIER:*]], [[AREA:*]], [[NODE:*]], [[NETWORK:*]], [[FV.COMPONENT:*]],
-                    [[UNIT:*]], [[TACTIC:*]], [[DECISION:*]]"
+                    [[UNIT:*]], [[CONCERN:*]], [[TACTIC:*]], [[DECISION:*]]"
                 labeled: true
                 qualified: true
                 properties:
@@ -3799,7 +3807,7 @@
                 center: self
                 nodes: "[[TACTIC:*]], [[NR.REQUIREMENT:*]], [[FV.COMPONENT:*]], [[UNIT:*]],
                     [[ASPECT:*]], [[NODE:*]], [[DM.ENTITY:*]], [[CONCERN:*]], [[DECISION:*]],
-                    [[TS.TIER:*.COMPONENT:*]]"
+                    [[TS.TIER:*.COMPONENT:*]], [[TEST-CASE:*]]"
                 labeled: true
                 qualified: true
                 properties:

package/package.json

@@ -1,6 +1,6 @@
 {
     "name":                                "@rse/specbook",
-    "version":                             "1.2.11",
+    "version":                             "1.2.13",
     "publishConfig":                       { "access": "public" },
     "description":                         "Markdown-based Specification Format (API, CLI and MCP service)",
     "license":                             "Apache-2.0",