Terminology Design tools integration

.github/workflows/framework.yml

@@ -2,47 +2,37 @@ name: framework
 
 on:
   pull_request:
-    branches: [master]
+    branches:
+      - master
   push:
-    branches: [master]
+    branches:
+      - master
+  workflow_dispatch:
 
 jobs:
-  checks:
-    if: github.event_name != 'push'
+  deploy:
+    name: Run Terminology Design tools and deploy docs
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v1
-      - uses: actions/setup-node@v1
-        with:
-          node-version: '16.x'
-      - name: Test Build
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v1
+
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install dependencies
+        run: bun install
+
+      - name: Run Terminology Design tools
+        run: npm run build:terminology
+
+      - name: Build and Deploy
         run: |
-          yarn install --frozen-lockfile
-          STAGING=true yarn docusaurus parse
-          STAGING=true yarn docusaurus glossary
-          STAGING=true yarn build
-          mv build public
-  gh-release:
-    if: github.event_name != 'pull_request'
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v1
-      - uses: actions/setup-node@v1
-        with:
-          node-version: '16.x'
-      - uses: webfactory/[email protected]
+          npx docusaurus build --out-dir build
+          touch build/.nojekyll
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
         with:
-          ssh-private-key: ${{ secrets.GH_PAGES_DEPLOY }}
-      - name: Release to GitHub Pages
-        env:
-          USE_SSH: true
-          GIT_USER: "MarIliadi"
-        run: |
-          git config --global user.email "[email protected]"
-          git config --global user.name "MarIliadi"
-          yarn install --frozen-lockfile
-          STAGING=true yarn docusaurus parse
-          STAGING=true yarn docusaurus glossary
-          STAGING=true yarn build
-          mv build public
-          STAGING=true yarn deploy
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./build

docs/saf.yaml

@@ -29,7 +29,7 @@ scope:
 #
 scopes:  #
 - scopetag: tev2 # definition of (scope) tag(s) that are used within this scope to refer to a specific terminology
-  scopedir: https://github.com/tno-terminology-design/tev2/tree/master/docs/tev2 # URL of the scope-directory
+  scopedir: https://github.com/tno-terminology-design/tev2-specifications/tree/main/docs # URL of the scope-directory
 #
 # The third section specifies the versions that are actively maintained by the curators.
 # For each version, the set of terms is selected that constitute the terminology.

docs/terminology-config.yaml

@@ -0,0 +1,23 @@
+# TNO Terminology Design tools configuration file (yaml)
+
+## General
+scopedir: docs      # path of the scope directory where the SAF is located
+onNotExist: warn    # the action in case a `vsntag` was specified, but wasn't found in the SAF
+
+
+## Machine Readable Glossary Tool
+vsntag:             # versiontag for which the MRG needs to be (re)generated. Leave empty to process all versions
+
+
+## Term Reference Resolution Tool
+output: .           # (root) directory for output files to be written
+interpreter:        # type of interpreter, either: a regex, "alt", or "basic"
+  (?:(?<=[^`\\])|^)\[(?=[^@\]]+\]\([#a-z0-9_-]*@[:a-z0-9_-]*\))(?<showtext>[^\n\]@]+)\]\((?:(?<id>[a-z0-9_-]*)?(?:#(?<trait>[a-z0-9_-]+))?)?@(?<scopetag>[a-z0-9_-]*)(?::(?<vsntag>[a-z0-9_-]+))?\)
+converter: >-       # Type of converter, either: a mustache template, "http", or "markdown"
+  <a
+  href="{{localize navurl}}{{#if trait}}#{{trait}}{{/if}}"
+  hovertext="{{#if hoverText}}{{hoverText}}{{else}}{{#if glossaryTerm}}{{glossaryTerm}}{{else}}{{capFirst term}}{{/if}}: {{noRefs glossaryText type="markdown"}}{{/if}}"
+  >{{showtext}}</a>
+force: true         # toggle overwriting of existing files
+input:              # glob pattern strings for files to be processed by the TRRT
+  - "**/*.md"

docs/terms/identify.md

@@ -10,7 +10,7 @@ formPhrases: identify, identifies, identifying, identifiable, identified, identi
 status: draft
 grouptags:
 hoverText: "Identify: an Act, by or on behalf of a Party, that results in the selection of either (a) a single Partial identity that the party Owns, given some (observed or received) data, or (b) a single Entity from a given set of entities that is the Subject of a specified Partial identity that the party Owns."
-glossaryText: "an [act](action@), by or on behalf of a [party](@), that results in the selection of either\n- a single [partial identity](@) that the party [owns](@), given some (observed or received) data, or\n- a single [entity](@) from a given set of entities that is the [subject](@) of a specified [partial identity](@) that the party [owns](@)."
+glossaryText: "an [act](action@), by or on behalf of a [party](@), that results in the selection of either
- a single [partial identity](@) that the party [owns](@), given some (observed or received) data, or
- a single [entity](@) from a given set of entities that is the [subject](@) of a specified [partial identity](@) that the party [owns](@)."
 date: 20210812
 ---
 

docusaurus.config.js

@@ -3,7 +3,7 @@ module.exports = {
   title: 'eSSIF-Lab',
   tagline: 'eSSIF-Lab Framework',
   url: 'https://essif-lab.github.io',
-  baseUrl: process.env.STAGING && process.env.STAGING === 'true' ? '/framework/' : '/',
+  baseUrl: '/framework/',
   favicon: 'images/favicon.ico',
   organizationName: 'essif-lab',
   projectName: 'framework',

package.json

@@ -2,9 +2,16 @@
   "name": "essif-lab",
   "version": "0.0.0",
   "private": true,
+  "config": {
+    "terminology": "docs/terminology-config.yaml"
+  },
   "scripts": {
     "start": "docusaurus start",
     "build": "docusaurus build",
+    "build:terminology": "npm run build:mrg-import && npm run build:mrgt && npm run build:trrt",
+    "build:mrg-import": "bun mrg-import -c $npm_package_config_terminology",
+    "build:mrgt": "bun mrgt -c $npm_package_config_terminology",
+    "build:trrt": "bun trrt -c $npm_package_config_terminology",
     "swizzle": "docusaurus swizzle",
     "deploy": "docusaurus deploy",
     "parse": "docusaurus parse",
@@ -16,6 +23,9 @@
     "@docusaurus/core": "^2.4.0",
     "@docusaurus/preset-classic": "^2.4.0",
     "@material-ui/core": "^4.11.0",
+    "@tno-terminology-design/mrg-import": "^0.1.5",
+    "@tno-terminology-design/mrgt": "^0.1.5",
+    "@tno-terminology-design/trrt": "^1.0.7",
     "classnames": "^2.2.6",
     "react": "^16.8.4",
     "react-dom": "^16.8.4"

src/css/custom.css

@@ -30,3 +30,37 @@ html[data-theme='dark'] {
   .button.button--secondary.button--outline:not(.button--active):not(:hover) {
   color: var(--ifm-color-secondary);
 }
+
+a[hovertext] {
+  position: relative;
+  cursor: help;
+  font-weight: 600;
+}
+
+a[hovertext]::after {
+  content: attr(hoverText);
+  position: absolute;
+  width: max-content;
+  background: var(--ifm-color-content);
+  color: var(--ifm-color-content-inverse);
+  font-size: var(--ifm-code-font-size);
+  font-weight: 400;
+  max-width: 25vw;
+  padding: 4px 8px;
+  border-radius: 4px;
+  line-height: 1.2em;
+  white-space: pre-wrap;
+  word-break: break-word;
+  top: calc(100% + 10px);
+  transform: translateX(-50%);
+  transition: opacity 0.3s, visibility 0.3s;
+  pointer-events: none;
+  z-index: 1;
+  opacity: 0;
+  visibility: hidden;
+}
+
+a[hovertext]:hover::after {
+  visibility: visible;
+  opacity: .95;
+}