spec-up-t 1.0.75 → 1.0.77

package/assets/compiled/body.js

@@ -126,7 +126,7 @@ function tokenInput(){let t=document.createElement("button");t.classList.add("bu
 function pdfDownload(){fetch("index.pdf",{method:"HEAD"}).then(e=>{if(e.ok){let e=document.createElement("a");e.classList.add("button-pdf-download"),e.classList.add("btn"),e.target="_blank",e.rel="noopener noreferrer",e.href="index.pdf",e.title="Download this page as a PDF",e.innerHTML="PDF",document.querySelector("#container-search-h7vc6omi2hr2880").appendChild(e)}else console.log("PDF file does not exist. No PDF download button will be added.")}).catch(e=>{console.error("Error checking PDF file:",e)})}document.addEventListener("DOMContentLoaded",(function(){pdfDownload()}));
 function helpButtons(){const t=document.createElement("a");t.textContent="?",t.classList.add("help-button","btn"),t.title="Click to see the explanation of the buttons at the documentation website, in a new tab.",t.target="_blank",t.rel="noopener noreferrer",t.href="https://blockchainbird.github.io/spec-up-t-website/docs/general/specification#explanation-buttons",function(t){document.querySelectorAll("#content dl dt").forEach(e=>{e.appendChild(t.cloneNode(!0))})}(t)}document.addEventListener("DOMContentLoaded",helpButtons);
 function createAlphabetIndex(){const e=document.getElementById("alphabet-index-h7vc6omi2hr2880"),t=document.querySelector(".terms-and-definitions-list").querySelectorAll("dt"),n={};t.forEach(e=>{const t=e.querySelector("span");if(t&&t.id){const e=t.id,o=e.charAt(e.indexOf("term:")+5).toUpperCase();n[o]||(n[o]=t.id)}});const o=document.createElement("div");o.className="alphabet-index";const r=document.createElement("p");r.className="number-of-terms",r.textContent=`– There are ${t.length} terms –`;const c=e.parentNode;c.insertBefore(r,e.nextSibling),c.insertBefore(o,r.nextSibling),Object.keys(n).sort().forEach(e=>{const t=document.createElement("a");t.href="#"+n[e],t.textContent=e,o.appendChild(t)})}document.addEventListener("DOMContentLoaded",(function(){createAlphabetIndex()}));
-function collapseDefinitions(){const t=document.querySelectorAll("#content dl dd"),e=document.querySelectorAll(".collapse-all-defs-button");document.querySelectorAll("dt").forEach(t=>{const e=document.createElement("button");e.classList.add("collapse-all-defs-button","btn"),e.innerHTML="▲",e.setAttribute("id","toggleButton"),t.appendChild(e)}),document.addEventListener("click",n=>{n.target.classList.contains("collapse-all-defs-button")&&(!function(){const n=t[0].classList.contains("hidden");t.forEach(t=>{t.classList.toggle("hidden",!n),t.classList.toggle("visible",n)}),e.forEach(t=>{t.innerHTML=n?"▲":"▼",t.title=n?"Collapse all definitions":"Expand all definitions"})}(),n.target.scrollIntoView({behavior:"smooth",block:"start",inline:"nearest"}),setTimeout(()=>{window.scrollBy({top:-100,behavior:"smooth"})},500))})}document.addEventListener("DOMContentLoaded",(function(){collapseDefinitions()}));
+function collapseDefinitions(){const t=document.querySelectorAll("#content dl.terms-and-definitions-list dd"),e=document.querySelectorAll("#content dl.terms-and-definitions-list dt"),n=document.querySelectorAll(".collapse-all-defs-button");e.forEach(t=>{const e=document.createElement("button");e.classList.add("collapse-all-defs-button","btn"),e.innerHTML="▲",e.setAttribute("id","toggleButton"),t.appendChild(e)}),document.addEventListener("click",e=>{e.target.classList.contains("collapse-all-defs-button")&&(!function(){const e=t[0].classList.contains("hidden");t.forEach(t=>{t.classList.toggle("hidden",!e),t.classList.toggle("visible",e)}),n.forEach(t=>{t.innerHTML=e?"▲":"▼",t.title=e?"Collapse all definitions":"Expand all definitions"})}(),e.target.scrollIntoView({behavior:"smooth",block:"start",inline:"nearest"}),setTimeout(()=>{window.scrollBy({top:-100,behavior:"smooth"})},500))})}document.addEventListener("DOMContentLoaded",(function(){collapseDefinitions()}));
 /**
  * @file This file adds an href attribute to the snapshot link on the page via client side JS DOM manipulation.
  * @author Kor Dwarshuis

package/assets/compiled/head.css

@@ -11,4 +11,4 @@ code[class*=language-],pre[class*=language-]{color:#ccc;background:0 0;font-fami
 .modal-overlay{position:fixed;top:0;left:0;width:100%;height:100%;background-color:rgba(0,0,0,.5);display:flex;justify-content:center;align-items:center;z-index:1000}.modal{background-color:#fff;padding:2rem 20px 20px;border-radius:8px;max-width:80%;max-height:80%;overflow-y:auto;position:relative;box-shadow:0 2px 10px rgba(0,0,0,.1)}.modal-close{position:absolute;top:0;right:5px;background-color:transparent;border:none;font-size:2rem;line-height:1;cursor:pointer}
 .alphabet-index{display:flex;flex-wrap:wrap;justify-content:center;margin:1em auto;padding:0;width:100%}.alphabet-index a{background-color:#f5f5f5;border:1px solid #e0e0e0;border-radius:50%;color:#333;display:block;font-size:1rem;height:33.33px;line-height:33.33px;margin:3.33px;text-align:center;text-decoration:none;width:33.33px}.number-of-terms{text-align:center}
 .button-pdf-download{padding-left:.1em;padding-right:.1em;border:none;background:red;color:#fff;box-shadow:2.8px 2.8px 2.2px rgba(0,0,0,.02),6.7px 6.7px 5.3px rgba(0,0,0,.028),12.5px 12.5px 10px rgba(0,0,0,.035),22.3px 22.3px 17.9px rgba(0,0,0,.042),41.8px 41.8px 33.4px rgba(0,0,0,.05),100px 100px 80px rgba(0,0,0,.07)}
-:root{--base-theme-color:207,71%;--themed-element-bk:hsl(var(--base-theme-color), 40%);--themed-element-text:#fff;--themed-element-border:1px solid hsl(var(--base-theme-color), 26%);--themed-heading-text:hsl(var(--base-theme-color), 30%);--no-color:255,255,255;--faint-color:245,245,245;--dim-color:225,225,225;--low-color:200,200,200;--mid-color:100,100,100;--high-color:50,50,50;--full-color:0,0,0;--active-color:#3aaaff;--visited-color:rgb(188, 129, 255);--green-status:rgb(0, 123, 9);--light-green-status:rgb(0, 194, 13);--page-bk:rgb(var(--no-color));--page-text:rgb(var(--full-color));--page-text-hover:rgb(var(--full-color));--element-bk:rgb(var(--no-color));--element-bk-hover:rgba(var(--low-color), 0.5);--element-bk-transparent:rgba(var(--dim-color), 0.92);--element-border:rgba(var(--high-color), 0.4);--element-border-focus:rgb(var(--full-color), 0.75);--element-border-radius:3px;--element-shadow-low:0 1px 3px 0px rgba(0,0,0, 0.25);--element-shadow-mid:0 1px 3px 0px rgba(0,0,0, 0.35);--element-shadow-high:0 1px 5px 0px rgba(0,0,0, 0.45);--code-bk:#1a1e23;--input-bk:rgba(var(--dim-color), 0.6);--input-border:rgba(var(--high-color), 0.4);--header-height:48px;--header-bk:rgba(var(--low-color), 0.985);--header-text:rgb(var(--full-color));--header-border:rgba(var(--full-color), 0.1);--header-border-inverse:rgba(var(--no-color), 0.3);--text-shadow:0 1px 2px rgba(0,0,0,0.8);--svg-size:2vw;--font-size:14px}:target{scroll-margin:calc(var(--header-height)/ .75) 0 0}body:not([hashscroll]) :target{animation:highlight 1.5s .25s ease}body{margin:0;padding:0;font-family:Heebo,san-serif;line-height:1.5em;widows:2;orphans:2;word-wrap:break-word;overflow-wrap:break-word;color:#000;word-spacing:1px;counter-reset:h2 toc1}h1{font-size:2em;font-weight:700;line-height:1.2em}h2{margin:1.5em 0 1em}blockquote{position:relative;padding:0;margin:1.75em .75em;color:rgb(var(--mid-color));background:rgb(var(--faint-color))}blockquote:after,blockquote:before{content:"“";position:absolute;top:.065em;left:.065em;font-size:3em;height:.34em;line-height:100%;color:rgb(var(--low-color))}blockquote:after{content:"”";top:auto;left:auto;bottom:.065em;right:.065em;text-align:center}blockquote>p{padding:.6em 1.8em .5em 1.8em}strong strong{font-size:.9em;color:#b30032;font-weight:400;text-transform:uppercase}main article>ol,main article>ul{padding:0 0 0 2em}main article h1,main article h2,main article h3,main article h4,main article h5,main article h6{color:var(--themed-heading-text)}main article h2,main article h3,main article h4{display:flex;font-weight:500}main article h2{counter-reset:h3 h4}main article h3{counter-reset:h4}main article h2:after{counter-increment:h2;content:counter(h2) ".";padding:0 .4em 0 .2em;order:-1}main article h3:after{counter-increment:h3;content:counter(h2) "." counter(h3);padding:0 .45em 0 .2em;order:-1}main article h4:after{counter-increment:h4;content:counter(h2) "." counter(h3) "." counter(h4);padding:0 .5em 0 .2em;order:-1}h1 .toc-anchor{display:none}.toc-anchor{margin:-.1em 0 0;font-size:.875em;color:inherit;text-decoration:none;opacity:.35;order:-1;transition:opacity .3s ease}.toc-anchor:hover{opacity:1}pre{overflow:auto}code{padding:.085em .3em .1em;font-size:1.075em;color:#c7001c;vertical-align:middle;background:#f0f0f0;border-radius:4px}pre code{background:unset;padding:unset;border-radius:unset}h1 code,h2 code,h3 code,h4 code,h5 code,h6 code{font-size:1.25em;margin:-.11em .3em 0 0;border-radius:3px}ol,ul{margin:0;padding:0 0 0 1.2em}dl{margin:0;padding:0}dt{font-weight:700;margin:0;background-color:#f0f0f0;border:1px solid #ccc;padding:10px;border-radius:5px 5px 0 0}dd{margin:0;background-color:#f9f9f9;border:1px solid #ccc;border-top:none;padding:.5em 2em;border-bottom:none}dd p{margin:0}dd+dd{border-bottom:none}dd+dt{margin-top:2em}dd.last-dd{border-radius:0 0 5px 5px;border-bottom:1px solid #ccc}main{box-sizing:border-box;float:right;width:75%;min-width:calc(100% - 325px);max-width:calc(100% - 275px);padding:.5em 2em 1.5em 2em;background:#fff;box-shadow:0 0 5px -1px rgba(0,0,0,.3)}table{display:block;width:-webkit-fill-available;width:fit-content;max-width:100%;margin:1.5em 0 1.75em;border-spacing:0;border-collapse:collapse;overflow-x:auto;word-wrap:normal;overflow-wrap:normal;hyphens:manual}thead tr th{color:var(--themed-element-text);background:var(--themed-element-bk);border:var(--themed-element-border);text-shadow:0 1px 1px rgba(0,0,0,.5)}tr{border-top:1px solid #ccc;background-color:#fff;margin:0;padding:0}tr:nth-child(2n){background-color:#f0f0f0}tr th{font-weight:400;border:1px solid #ccc;text-align:left;margin:0;padding:6px 13px}td,th{padding:9px 13px;border:1px solid #d8d8d8}tr td{border:1px solid #ccc;text-align:left;margin:0;padding:.55em .75em .55em}tr td :first-child,tr th :first-child{margin-top:0}tr td :last-child,tr th :last-child{margin-bottom:0}table pre[class*=language-]{border:none;border-radius:0}table pre[class*=language-]:before{display:none}svg[icon]{width:1.25em;height:1.25em;vertical-align:text-top;pointer-events:none}article p>img{max-width:100%;margin:0 auto}article li{margin-top:.4em}slide-panel>:not(header):not(footer){flex:1}:not(pre)>code[class*=language-],pre[class*=language-]{padding:.65em .8em .8em;background:var(--code-bk)}.tippy-box{box-shadow:var(--element-shadow-mid)}.tippy-box a{color:var(--active-color)}.tippy-box a:visited{color:var(--visited-color)}.tippy-content{padding:.55em .55em .5em}.tippy-content header{margin:0 0 .4em;padding:.15em .3em .1em;border-radius:2px;background:rgba(255,255,255,.1);text-shadow:0 1px rgba(0,0,0,.9)}.tippy-content table,.tippy-content tbody,.tippy-content td,.tippy-content tr{margin:0;padding:0;border:none;border-spacing:0;border-collapse:collapse;background:0 0!important;background-color:transparent!important}.tippy-content table{margin:0 .3em}.tippy-content td{font-size:.9em;padding:.2em 0 0}.tippy-content td:first-child{padding-right:.5em}a[path-0$="github.com"]:before{content:"\f09b";color:var(--page-text);margin:0 .25em 0 0;font-family:FontAwesome;text-decoration:none;display:inline-block;vertical-align:bottom}a[path-0$="github.com"][path-3=issues][path-4],a[path-0$="github.com"][path-3=projects],a[path-0$="github.com"][path-3=pull],a[path-0$="github.com"][path-3=releases]{text-decoration:none}a[path-0$="github.com"][path-3=issues][path-4] span,a[path-0$="github.com"][path-3=projects] span,a[path-0$="github.com"][path-3=pull] span,a[path-0$="github.com"][path-3=releases] span{display:none}a[path-0$="github.com"][path-3=issues][path-4]:after{content:"Issue #" attr(path-4)}a[path-0$="github.com"][path-3=pull]:after{content:"Pull Request #" attr(path-4)}a[path-0$="github.com"][path-3=releases][path-5]:after{content:"Release " attr(path-5)}a[path-0$="github.com"][path-3=projects]:after{content:"Project #" attr(path-4)}[issue-count]:after{content:"Issues (" attr(issue-count) ")";margin:0 0 0 .3em;padding:.1em 0 0}[issue-count=""][animate]{display:none;opacity:0}[issue-count][animate]:not([issue-count=""]){animation:display-show 1s}[panel-toggle]{cursor:pointer}.panel-header{display:flex;align-items:center;height:var(--header-height)}.panel-header>*{display:flex;height:100%;padding:.1em .8em 0;align-items:center}.slide-panel{width:calc(100% - 1em);max-width:475px;transition:transform .35s ease}.slide-panel[panel-open]{transform:translateX(0)}.notice{margin:1em 0;padding:.5em .9em .55em .65em;border-left:.5em solid}.notice p{margin:.4em 0 0}.note{background:#e9fbe9;border-color:#52e052}.note .notice-link{display:block;color:#178217}.issue{background:#e9f0fb;border-color:#527fe0}.issue .notice-link:before{display:block;color:#1e4cae}.warning{background:#fbe9e9;border-color:#e05252}.warning .notice-link{display:block;color:#ae1e1e}.example{color:#cebe00;background:#1a1e23;border-left:.5em solid}.example .notice-link{display:block;color:inherit;font-size:1.1em;font-family:Heebo,san-serif}.example pre[class*=language-]{padding:0;border-radius:0}.todo{background:#fbe4ff;border-color:#9700e2}.todo .notice-link{display:block;color:#6d00a2}.mermaid{display:flex;align-items:center;justify-content:center;margin:1.5em 0 1.75em}.reference-list{margin:0;padding:0;list-style:none}.reference-list dd a,.reference-status{font-style:italic}.reference-status{color:var(--green-status)}.tippy-box .reference-status{color:var(--light-green-status)}code[class*=language-],pre,pre[class*=language-]{font-size:.9em;margin:1em 0 1.5em;border-radius:3px}.example code[class*=language-],.example pre,.example pre[class*=language-]{margin:0}#svg{display:none}#header{position:sticky;position:-webkit-sticky;padding:0;top:0;margin:-.5em -2em 0 -2em;background:rgba(255,255,255,.9);border-bottom:1px solid rgba(0,0,0,.175);box-shadow:0 1px 3px 1px rgba(0,0,0,.1);z-index:2}#logo{box-sizing:border-box;display:flex;align-items:center;height:100%;padding:.5em}#logo img{height:100%}#logo+span{margin-left:auto}#header #toc_toggle{display:none;padding:0 1em;border-right:1px solid rgba(0,0,0,.15)}#content{max-width:800px}#content h1:first-of-type{margin:1em 0 .5em}#content h1:first-of-type .markdownIt-Anchor{display:none}#repo_issues{width:calc(100% - 1.5em);max-width:450px;border-left:1px solid rgba(0,0,0,.15)}#repo_issues>header{background:#eee;border-bottom:1px solid #ddd}#repo_issues>header span:first-of-type{font-weight:700;padding-top:.1em}#repo_issues>header .repo-issue-toggle{margin-left:auto;color:inherit;font-weight:700;text-decoration:none}#repo_issue_list{list-style:none;margin:0;padding:0 1.25em 1.25em;font-size:.85em;overflow:auto;-ms-overflow-style:none;scrollbar-width:none}#repo_issue_list::-webkit-scrollbar{display:none}#repo_issue_list:empty:before{content:"No issues found";display:block;text-align:center;font-size:1.1em;color:#aaa;margin:1em 0 0}.repo-issue detail-box{display:flex;flex-direction:column;padding:1em 0;border-bottom:1px solid #ddd}.repo-issue detail-box>section{order:1}.repo-issue detail-box>section:empty+.repo-issue-title [detail-box-toggle]{display:none}.repo-issue-title{display:flex;align-items:center}.repo-issue-link{flex:1;margin:0 0 0 .5em}.repo-issue-number{height:1em;margin:0 .4em 0 0;padding:.3em .25em 0;border-radius:3px;font-weight:700;background:#eee;border:1px solid #ddd;text-align:center;line-height:1em}.repo-issue-number:before{content:"#";font-weight:400;margin:0 .1em 0 0}.repo-issue [detail-box-toggle]{margin:0 0 0 1em;opacity:.35;transition:opacity .4s}.repo-issue [detail-box-toggle]:hover,.repo-issue detail-box[open] [detail-box-toggle]{opacity:1}#toc{display:flex;flex-direction:column;width:25%;max-width:325px;min-width:275px;background:#eceff1}#toc header{color:var(--themed-element-text);background:var(--themed-element-bk);box-shadow:0 1px 3px 0 rgba(0,0,0,.3);border:var(--themed-element-border);border-top:none;border-left:none}#toc header [panel-toggle]{display:none;height:var(--header-height);line-height:var(--header-height);margin-left:auto;padding:0 1em;color:inherit;font-weight:700;text-decoration:none}#toc_list{flex:1;padding:1em .8em;overflow:auto}.toc{padding:0 0 1.75em;font-size:.85em}.toc,.toc ul{margin:0;list-style:none}.toc ul{padding:0 0 0 1em}.toc a{display:block;padding:.4em .3em .225em;text-decoration:none;border-radius:3px;color:#333}.toc a:before{color:#000;font-weight:700}.toc a:hover{text-shadow:0 1px 1px #fff;background:rgba(0,0,0,.1)}.toc>li a:before{counter-increment:toc1;content:counter(toc1) ".";padding:0 .4em 0 .2em}.toc>li>ul{counter-reset:toc2}.toc>li>ul>li a:before{counter-increment:toc2;content:counter(toc1) "." counter(toc2);padding:0 .45em 0 .2em}.toc>li>ul ul{counter-reset:toc3}.toc>li>ul ul li a:before{counter-increment:toc3;content:counter(toc1) "." counter(toc2) "." counter(toc3);padding:0 .5em 0 .2em}@media (min-width:900px){slide-panel{z-index:2}#slidepanels[open=sidebar]:before{opacity:0;transition:none;pointer-events:none}#slidepanels:before{z-index:1}#toc{transition:none;transform:translate3d(0,0,0);box-shadow:0 0 5px 1px rgba(0,0,0,.15) inset;z-index:0}}@media (max-width:900px){main{width:100%;min-width:auto;max-width:none;padding:.5em 1.25em 1.5em 1.25em}#header{margin:-.5em -1.25em 0 -1.25em}#toc header [panel-toggle]{display:block}#header #toc_toggle{display:flex}}@media (max-width:550px){td{font-size:.8em}}@keyframes display-show{0%{display:none;opacity:0}1%{display:block}100%{opacity:1}}@keyframes highlight{50%{background-color:#ff0}}article a[href^="https://"]:not(.btn)::after,article a[href^=http]:not(.btn)::after{content:'';width:12px;height:12px;margin-left:4px;background-image:url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='16' height='16' fill='currentColor' viewBox='0 0 16 16'%3E%3Cpath fill-rule='evenodd' d='M8.636 3.5a.5.5 0 0 0-.5-.5H1.5A1.5 1.5 0 0 0 0 4.5v10A1.5 1.5 0 0 0 1.5 16h10a1.5 1.5 0 0 0 1.5-1.5V7.864a.5.5 0 0 0-1 0V14.5a.5.5 0 0 1-.5.5h-10a.5.5 0 0 1-.5-.5v-10a.5.5 0 0 1 .5-.5h6.636a.5.5 0 0 0 .5-.5z'/%3E%3Cpath fill-rule='evenodd' d='M16 .5a.5.5 0 0 0-.5-.5h-5a.5.5 0 0 0 0 1h3.793L6.146 9.146a.5.5 0 1 0 .708.708L15 1.707V5.5a.5.5 0 0 0 1 0v-5z'/%3E%3C/svg%3E");background-position:center;background-repeat:no-repeat;background-size:contain;display:inline-block}.btn,.no-xref-found-message{font-variant:small-caps;text-transform:uppercase}.no-xref-found-message{background:#f8c481!important;color:#03365f!important;margin:0 .5em;padding:0 .8em;border-radius:.25rem;font-size:.8rem}.powered-by,.snapshots{margin:0;padding:0;flex:none}.powered-by{text-align:center;font-size:.7em}.snapshots a{display:block;margin:.5em;padding:.5em .8em;border-radius:.25rem;background:#a9dde0;color:#03365f;text-decoration:none;font-size:1rem}
+:root{--base-theme-color:207,71%;--themed-element-bk:hsl(var(--base-theme-color), 40%);--themed-element-text:#fff;--themed-element-border:1px solid hsl(var(--base-theme-color), 26%);--themed-heading-text:hsl(var(--base-theme-color), 30%);--no-color:255,255,255;--faint-color:245,245,245;--dim-color:225,225,225;--low-color:200,200,200;--mid-color:100,100,100;--high-color:50,50,50;--full-color:0,0,0;--active-color:#3aaaff;--visited-color:rgb(188, 129, 255);--green-status:rgb(0, 123, 9);--light-green-status:rgb(0, 194, 13);--page-bk:rgb(var(--no-color));--page-text:rgb(var(--full-color));--page-text-hover:rgb(var(--full-color));--element-bk:rgb(var(--no-color));--element-bk-hover:rgba(var(--low-color), 0.5);--element-bk-transparent:rgba(var(--dim-color), 0.92);--element-border:rgba(var(--high-color), 0.4);--element-border-focus:rgb(var(--full-color), 0.75);--element-border-radius:3px;--element-shadow-low:0 1px 3px 0px rgba(0,0,0, 0.25);--element-shadow-mid:0 1px 3px 0px rgba(0,0,0, 0.35);--element-shadow-high:0 1px 5px 0px rgba(0,0,0, 0.45);--code-bk:#1a1e23;--input-bk:rgba(var(--dim-color), 0.6);--input-border:rgba(var(--high-color), 0.4);--header-height:48px;--header-bk:rgba(var(--low-color), 0.985);--header-text:rgb(var(--full-color));--header-border:rgba(var(--full-color), 0.1);--header-border-inverse:rgba(var(--no-color), 0.3);--text-shadow:0 1px 2px rgba(0,0,0,0.8);--svg-size:2vw;--font-size:14px}:target{scroll-margin:calc(var(--header-height)/ .75) 0 0}body:not([hashscroll]) :target{animation:highlight 1.5s .25s ease}body{margin:0;padding:0;font-family:Heebo,san-serif;line-height:1.5em;widows:2;orphans:2;word-wrap:break-word;overflow-wrap:break-word;color:#000;word-spacing:1px;counter-reset:h2 toc1}h1{font-size:2em;font-weight:700;line-height:1.2em}h2{margin:1.5em 0 1em}blockquote{position:relative;padding:0;margin:1.75em .75em;color:rgb(var(--mid-color));background:rgb(var(--faint-color))}blockquote:after,blockquote:before{content:"“";position:absolute;top:.065em;left:.065em;font-size:3em;height:.34em;line-height:100%;color:rgb(var(--low-color))}blockquote:after{content:"”";top:auto;left:auto;bottom:.065em;right:.065em;text-align:center}blockquote>p{padding:.6em 1.8em .5em 1.8em}strong strong{font-size:.9em;color:#b30032;font-weight:400;text-transform:uppercase}main article>ol,main article>ul{padding:0 0 0 2em}main article h1,main article h2,main article h3,main article h4,main article h5,main article h6{color:var(--themed-heading-text)}main article h2,main article h3,main article h4{display:flex;font-weight:500}main article h2{counter-reset:h3 h4}main article h3{counter-reset:h4}main article h2:after{counter-increment:h2;content:counter(h2) ".";padding:0 .4em 0 .2em;order:-1}main article h3:after{counter-increment:h3;content:counter(h2) "." counter(h3);padding:0 .45em 0 .2em;order:-1}main article h4:after{counter-increment:h4;content:counter(h2) "." counter(h3) "." counter(h4);padding:0 .5em 0 .2em;order:-1}h1 .toc-anchor{display:none}.toc-anchor{margin:-.1em 0 0;font-size:.875em;color:inherit;text-decoration:none;opacity:.35;order:-1;transition:opacity .3s ease}.toc-anchor:hover{opacity:1}pre{overflow:auto}code{padding:.085em .3em .1em;font-size:1.075em;color:#c7001c;vertical-align:middle;background:#f0f0f0;border-radius:4px}pre code{background:unset;padding:unset;border-radius:unset}h1 code,h2 code,h3 code,h4 code,h5 code,h6 code{font-size:1.25em;margin:-.11em .3em 0 0;border-radius:3px}ol,ul{margin:0;padding:0 0 0 1.2em}dl.terms-and-definitions-list{margin:0;padding:0}dl.terms-and-definitions-list dt{font-weight:700;margin:0;background-color:#f0f0f0;border:1px solid #ccc;padding:10px;border-radius:5px 5px 0 0}dl.terms-and-definitions-list dd{margin:0;background-color:#f9f9f9;border:1px solid #ccc;border-top:none;padding:.5em 2em;border-bottom:none}dl.terms-and-definitions-list dd p{margin:0}dl.terms-and-definitions-list dd+dd{border-bottom:none}dl.terms-and-definitions-list dd+dt{margin-top:2em}dl.terms-and-definitions-list dd.last-dd{border-radius:0 0 5px 5px;border-bottom:1px solid #ccc}main{box-sizing:border-box;float:right;width:75%;min-width:calc(100% - 325px);max-width:calc(100% - 275px);padding:.5em 2em 1.5em 2em;background:#fff;box-shadow:0 0 5px -1px rgba(0,0,0,.3)}table{display:block;width:-webkit-fill-available;width:fit-content;max-width:100%;margin:1.5em 0 1.75em;border-spacing:0;border-collapse:collapse;overflow-x:auto;word-wrap:normal;overflow-wrap:normal;hyphens:manual}thead tr th{color:var(--themed-element-text);background:var(--themed-element-bk);border:var(--themed-element-border);text-shadow:0 1px 1px rgba(0,0,0,.5)}tr{border-top:1px solid #ccc;background-color:#fff;margin:0;padding:0}tr:nth-child(2n){background-color:#f0f0f0}tr th{font-weight:400;border:1px solid #ccc;text-align:left;margin:0;padding:6px 13px}td,th{padding:9px 13px;border:1px solid #d8d8d8}tr td{border:1px solid #ccc;text-align:left;margin:0;padding:.55em .75em .55em}tr td :first-child,tr th :first-child{margin-top:0}tr td :last-child,tr th :last-child{margin-bottom:0}table pre[class*=language-]{border:none;border-radius:0}table pre[class*=language-]:before{display:none}svg[icon]{width:1.25em;height:1.25em;vertical-align:text-top;pointer-events:none}article p>img{max-width:100%;margin:0 auto}article li{margin-top:.4em}slide-panel>:not(header):not(footer){flex:1}:not(pre)>code[class*=language-],pre[class*=language-]{padding:.65em .8em .8em;background:var(--code-bk)}.tippy-box{box-shadow:var(--element-shadow-mid)}.tippy-box a{color:var(--active-color)}.tippy-box a:visited{color:var(--visited-color)}.tippy-content{padding:.55em .55em .5em}.tippy-content header{margin:0 0 .4em;padding:.15em .3em .1em;border-radius:2px;background:rgba(255,255,255,.1);text-shadow:0 1px rgba(0,0,0,.9)}.tippy-content table,.tippy-content tbody,.tippy-content td,.tippy-content tr{margin:0;padding:0;border:none;border-spacing:0;border-collapse:collapse;background:0 0!important;background-color:transparent!important}.tippy-content table{margin:0 .3em}.tippy-content td{font-size:.9em;padding:.2em 0 0}.tippy-content td:first-child{padding-right:.5em}a[path-0$="github.com"]:before{content:"\f09b";color:var(--page-text);margin:0 .25em 0 0;font-family:FontAwesome;text-decoration:none;display:inline-block;vertical-align:bottom}a[path-0$="github.com"][path-3=issues][path-4],a[path-0$="github.com"][path-3=projects],a[path-0$="github.com"][path-3=pull],a[path-0$="github.com"][path-3=releases]{text-decoration:none}a[path-0$="github.com"][path-3=issues][path-4] span,a[path-0$="github.com"][path-3=projects] span,a[path-0$="github.com"][path-3=pull] span,a[path-0$="github.com"][path-3=releases] span{display:none}a[path-0$="github.com"][path-3=issues][path-4]:after{content:"Issue #" attr(path-4)}a[path-0$="github.com"][path-3=pull]:after{content:"Pull Request #" attr(path-4)}a[path-0$="github.com"][path-3=releases][path-5]:after{content:"Release " attr(path-5)}a[path-0$="github.com"][path-3=projects]:after{content:"Project #" attr(path-4)}[issue-count]:after{content:"Issues (" attr(issue-count) ")";margin:0 0 0 .3em;padding:.1em 0 0}[issue-count=""][animate]{display:none;opacity:0}[issue-count][animate]:not([issue-count=""]){animation:display-show 1s}[panel-toggle]{cursor:pointer}.panel-header{display:flex;align-items:center;height:var(--header-height)}.panel-header>*{display:flex;height:100%;padding:.1em .8em 0;align-items:center}.slide-panel{width:calc(100% - 1em);max-width:475px;transition:transform .35s ease}.slide-panel[panel-open]{transform:translateX(0)}.notice{margin:1em 0;padding:.5em .9em .55em .65em;border-left:.5em solid}.notice p{margin:.4em 0 0}.note{background:#e9fbe9;border-color:#52e052}.note .notice-link{display:block;color:#178217}.issue{background:#e9f0fb;border-color:#527fe0}.issue .notice-link:before{display:block;color:#1e4cae}.warning{background:#fbe9e9;border-color:#e05252}.warning .notice-link{display:block;color:#ae1e1e}.example{color:#cebe00;background:#1a1e23;border-left:.5em solid}.example .notice-link{display:block;color:inherit;font-size:1.1em;font-family:Heebo,san-serif}.example pre[class*=language-]{padding:0;border-radius:0}.todo{background:#fbe4ff;border-color:#9700e2}.todo .notice-link{display:block;color:#6d00a2}.mermaid{display:flex;align-items:center;justify-content:center;margin:1.5em 0 1.75em}.reference-list{margin:0;padding:0;list-style:none}.reference-list dd a,.reference-status{font-style:italic}.reference-status{color:var(--green-status)}.tippy-box .reference-status{color:var(--light-green-status)}code[class*=language-],pre,pre[class*=language-]{font-size:.9em;margin:1em 0 1.5em;border-radius:3px}.example code[class*=language-],.example pre,.example pre[class*=language-]{margin:0}#svg{display:none}#header{position:sticky;position:-webkit-sticky;padding:0;top:0;margin:-.5em -2em 0 -2em;background:rgba(255,255,255,.9);border-bottom:1px solid rgba(0,0,0,.175);box-shadow:0 1px 3px 1px rgba(0,0,0,.1);z-index:2}#logo{box-sizing:border-box;display:flex;align-items:center;height:100%;padding:.5em}#logo img{height:100%}#logo+span{margin-left:auto}#header #toc_toggle{display:none;padding:0 1em;border-right:1px solid rgba(0,0,0,.15)}#content{max-width:800px}#content h1:first-of-type{margin:1em 0 .5em}#content h1:first-of-type .markdownIt-Anchor{display:none}#repo_issues{width:calc(100% - 1.5em);max-width:450px;border-left:1px solid rgba(0,0,0,.15)}#repo_issues>header{background:#eee;border-bottom:1px solid #ddd}#repo_issues>header span:first-of-type{font-weight:700;padding-top:.1em}#repo_issues>header .repo-issue-toggle{margin-left:auto;color:inherit;font-weight:700;text-decoration:none}#repo_issue_list{list-style:none;margin:0;padding:0 1.25em 1.25em;font-size:.85em;overflow:auto;-ms-overflow-style:none;scrollbar-width:none}#repo_issue_list::-webkit-scrollbar{display:none}#repo_issue_list:empty:before{content:"No issues found";display:block;text-align:center;font-size:1.1em;color:#aaa;margin:1em 0 0}.repo-issue detail-box{display:flex;flex-direction:column;padding:1em 0;border-bottom:1px solid #ddd}.repo-issue detail-box>section{order:1}.repo-issue detail-box>section:empty+.repo-issue-title [detail-box-toggle]{display:none}.repo-issue-title{display:flex;align-items:center}.repo-issue-link{flex:1;margin:0 0 0 .5em}.repo-issue-number{height:1em;margin:0 .4em 0 0;padding:.3em .25em 0;border-radius:3px;font-weight:700;background:#eee;border:1px solid #ddd;text-align:center;line-height:1em}.repo-issue-number:before{content:"#";font-weight:400;margin:0 .1em 0 0}.repo-issue [detail-box-toggle]{margin:0 0 0 1em;opacity:.35;transition:opacity .4s}.repo-issue [detail-box-toggle]:hover,.repo-issue detail-box[open] [detail-box-toggle]{opacity:1}#toc{display:flex;flex-direction:column;width:25%;max-width:325px;min-width:275px;background:#eceff1}#toc header{color:var(--themed-element-text);background:var(--themed-element-bk);box-shadow:0 1px 3px 0 rgba(0,0,0,.3);border:var(--themed-element-border);border-top:none;border-left:none}#toc header [panel-toggle]{display:none;height:var(--header-height);line-height:var(--header-height);margin-left:auto;padding:0 1em;color:inherit;font-weight:700;text-decoration:none}#toc_list{flex:1;padding:1em .8em;overflow:auto}.toc{padding:0 0 1.75em;font-size:.85em}.toc,.toc ul{margin:0;list-style:none}.toc ul{padding:0 0 0 1em}.toc a{display:block;padding:.4em .3em .225em;text-decoration:none;border-radius:3px;color:#333}.toc a:before{color:#000;font-weight:700}.toc a:hover{text-shadow:0 1px 1px #fff;background:rgba(0,0,0,.1)}.toc>li a:before{counter-increment:toc1;content:counter(toc1) ".";padding:0 .4em 0 .2em}.toc>li>ul{counter-reset:toc2}.toc>li>ul>li a:before{counter-increment:toc2;content:counter(toc1) "." counter(toc2);padding:0 .45em 0 .2em}.toc>li>ul ul{counter-reset:toc3}.toc>li>ul ul li a:before{counter-increment:toc3;content:counter(toc1) "." counter(toc2) "." counter(toc3);padding:0 .5em 0 .2em}@media (min-width:900px){slide-panel{z-index:2}#slidepanels[open=sidebar]:before{opacity:0;transition:none;pointer-events:none}#slidepanels:before{z-index:1}#toc{transition:none;transform:translate3d(0,0,0);box-shadow:0 0 5px 1px rgba(0,0,0,.15) inset;z-index:0}}@media (max-width:900px){main{width:100%;min-width:auto;max-width:none;padding:.5em 1.25em 1.5em 1.25em}#header{margin:-.5em -1.25em 0 -1.25em}#toc header [panel-toggle]{display:block}#header #toc_toggle{display:flex}}@media (max-width:550px){td{font-size:.8em}}@keyframes display-show{0%{display:none;opacity:0}1%{display:block}100%{opacity:1}}@keyframes highlight{50%{background-color:#ff0}}article a[href^="https://"]:not(.btn)::after,article a[href^=http]:not(.btn)::after{content:'';width:12px;height:12px;margin-left:4px;background-image:url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='16' height='16' fill='currentColor' viewBox='0 0 16 16'%3E%3Cpath fill-rule='evenodd' d='M8.636 3.5a.5.5 0 0 0-.5-.5H1.5A1.5 1.5 0 0 0 0 4.5v10A1.5 1.5 0 0 0 1.5 16h10a1.5 1.5 0 0 0 1.5-1.5V7.864a.5.5 0 0 0-1 0V14.5a.5.5 0 0 1-.5.5h-10a.5.5 0 0 1-.5-.5v-10a.5.5 0 0 1 .5-.5h6.636a.5.5 0 0 0 .5-.5z'/%3E%3Cpath fill-rule='evenodd' d='M16 .5a.5.5 0 0 0-.5-.5h-5a.5.5 0 0 0 0 1h3.793L6.146 9.146a.5.5 0 1 0 .708.708L15 1.707V5.5a.5.5 0 0 0 1 0v-5z'/%3E%3C/svg%3E");background-position:center;background-repeat:no-repeat;background-size:contain;display:inline-block}.btn,.no-xref-found-message{font-variant:small-caps;text-transform:uppercase}.no-xref-found-message{background:#f8c481!important;color:#03365f!important;margin:0 .5em;padding:0 .8em;border-radius:.25rem;font-size:.8rem}.powered-by,.snapshots{margin:0;padding:0;flex:none}.powered-by{text-align:center;font-size:.7em}.snapshots a{display:block;margin:.5em;padding:.5em .8em;border-radius:.25rem;background:#a9dde0;color:#03365f;text-decoration:none;font-size:1rem}

package/assets/css/index.css

@@ -227,12 +227,13 @@ ol, ul {
   padding: 0 0 0 1.2em;
 }
 
-dl {
+/* START: Definition list for terms */
+dl.terms-and-definitions-list {
   margin: 0;
   padding: 0;
 }
 
-dt {
+dl.terms-and-definitions-list dt {
   font-weight: bold;
   margin: 0;
   background-color: #f0f0f0;
@@ -241,7 +242,7 @@ dt {
   border-radius: 5px 5px 0 0;
 }
 
-dd {
+dl.terms-and-definitions-list dd {
   margin: 0;
   background-color: #f9f9f9;
   border: 1px solid #ccc;
@@ -252,24 +253,26 @@ dd {
   /* Remove bottom borders for all dd's by default */
 }
 
-dd p {
+dl.terms-and-definitions-list dd p {
   margin: 0;
 }
 
 /* Remove borders between consecutive <dd> elements */
-dd+dd {
+dl.terms-and-definitions-list dd+dd {
   border-bottom: none;
 }
 
 /* Add a margin between the last <dd> and the next <dt> */
-dd+dt {
+dl.terms-and-definitions-list dd+dt {
   margin-top: 2em;
 }
 
-dd.last-dd {
+dl.terms-and-definitions-list dd.last-dd {
   border-radius: 0 0 5px 5px;
   border-bottom: 1px solid #ccc;
 }
+/* END: Definition list for terms */
+
 
 main {
   box-sizing: border-box;

package/assets/js/collapse-definitions.js

@@ -1,5 +1,6 @@
 function collapseDefinitions() {
-    const dds = document.querySelectorAll('#content dl dd');
+    const dds = document.querySelectorAll('#content dl.terms-and-definitions-list > dd');
+    const dts = document.querySelectorAll('#content dl.terms-and-definitions-list > dt');
     const buttons = document.querySelectorAll('.collapse-all-defs-button');
 
     function toggleVisibility() {
@@ -15,7 +16,7 @@ function collapseDefinitions() {
     }
 
     // Add button as last child of every <dl>
-    document.querySelectorAll('dt').forEach(dt => {
+    dts.forEach(dt => {
         const button = document.createElement('button');
         button.classList.add('collapse-all-defs-button', 'btn');
         button.innerHTML = '▲';

package/index.js

@@ -2,6 +2,7 @@
 module.exports = function (options = {}) {
   const fs = require('fs-extra');
   const path = require('path');
+  const gulp = require('gulp');
 
   const {
     fetchExternalSpecs,
@@ -21,7 +22,6 @@ module.exports = function (options = {}) {
   const { insertTermIndex } = require('./src/insert-term-index.js');
   insertTermIndex();
 
-  const gulp = require('gulp');
   const findPkgDir = require('find-pkg-dir');
   const modulePath = findPkgDir(__dirname);
   let config = fs.readJsonSync('./output/specs-generated.json');
@@ -29,6 +29,8 @@ module.exports = function (options = {}) {
   const createVersionsIndex = require('./src/create-versions-index.js');
   createVersionsIndex(config.specs[0].output_path);
 
+  const { fixMarkdownFiles } = require('./src/fix-markdown-files.js');
+
   let template = fs.readFileSync(path.join(modulePath, 'templates/template.html'), 'utf8');
   let assets = fs.readJsonSync(modulePath + '/src/asset-map.json');
   let externalReferences;
@@ -46,20 +48,25 @@ module.exports = function (options = {}) {
         return fs.readFileSync(path, 'utf8');
       }
     }
-  ];
+  ];  
 
-  const { processMarkdownFiles } = require('./src/fix-markdown-files.js');
+  // Synchronously process markdown files
+  fixMarkdownFiles(path.join(config.specs[0].spec_directory, config.specs[0].spec_terms_directory));
+  
+  function createScriptElementWithXrefDataForEmbeddingInHtml() {
+    // Test if xrefs-data.js exists, else make it an empty string
+    const inputPath = path.join('output', 'xrefs-data.js');
 
-  // Synchonously process markdown files
-  processMarkdownFiles(path.join(config.specs[0].spec_directory, config.specs[0].spec_terms_directory));
+    let xrefsData = "";
+    if (fs.existsSync(inputPath)) {
+      xrefsData = '<script>' + fs.readFileSync(inputPath, 'utf8') + '</script>';
+    }
 
-  // Test if xrefs-data.js exists, else make it an empty string
-  const inputPath = 'output/xrefs-data.js';
-  let xrefsData = "";
-  if (fs.existsSync(inputPath)) {
-    xrefsData = '<script>' + fs.readFileSync(inputPath, 'utf8') + '</script>';
+    return xrefsData;
   }
 
+  const xrefsData = createScriptElementWithXrefDataForEmbeddingInHtml();
+
   function applyReplacers(doc) {
     return doc.replace(replacerRegex, function (match, type, args) {
       let replacer = replacers.find(r => type.trim().match(r.test));
@@ -101,6 +108,74 @@ module.exports = function (options = {}) {
     throw Error("katex distribution could not be located");
   }
 
+  // Custom plugin to add class to <dl> and the last <dd> in each series after a <dt>
+  function addClassToDefinitionList(md) {
+    const originalRender = md.renderer.rules.dl_open || function (tokens, idx, options, env, self) {
+      return self.renderToken(tokens, idx, options);
+    };
+
+    // Variable to keep track of whether the class has been added to the first <dl> after the target HTML
+    let classAdded = false;
+
+    md.renderer.rules.dl_open = function (tokens, idx, options, env, self) {
+      
+      const targetHtml = 'terminology-section-start-h7vc6omi2hr2880';
+      let targetIndex = -1;
+
+      // Find the index of the target HTML
+      for (let i = 0; i < tokens.length; i++) {
+        if (tokens[i].content && tokens[i].content.includes(targetHtml)) {
+          targetIndex = i;
+          break;
+        }
+      }
+
+      // Add class to the first <dl> only if it comes after the target HTML
+      if (targetIndex !== -1 && idx > targetIndex && !classAdded) {
+        tokens[idx].attrPush(['class', 'terms-and-definitions-list']);
+        classAdded = true;
+      }
+
+      let lastDdIndex = -1;
+
+      for (let i = idx + 1; i < tokens.length; i++) {
+        if (tokens[i].type === 'dl_close') {
+          // Add class to the last <dd> before closing <dl>
+          if (lastDdIndex !== -1) {
+            const ddToken = tokens[lastDdIndex];
+            const classIndex = ddToken.attrIndex('class');
+            if (classIndex < 0) {
+              ddToken.attrPush(['class', 'last-dd']);
+            } else {
+              ddToken.attrs[classIndex][1] += ' last-dd';
+            }
+          }
+          break;
+        }
+
+        if (tokens[i].type === 'dt_open') {
+          // Add class to the last <dd> before a new <dt>
+          if (lastDdIndex !== -1) {
+            const ddToken = tokens[lastDdIndex];
+            const classIndex = ddToken.attrIndex('class');
+            if (classIndex < 0) {
+              ddToken.attrPush(['class', 'last-dd']);
+            } else {
+              ddToken.attrs[classIndex][1] += ' last-dd';
+            }
+            lastDdIndex = -1; // Reset for the next series
+          }
+        }
+
+        if (tokens[i].type === 'dd_open') {
+          lastDdIndex = i;
+        }
+      }
+
+      return originalRender(tokens, idx, options, env, self);
+    };
+  }
+
   try {
 
     var toc;
@@ -218,55 +293,7 @@ module.exports = function (options = {}) {
       })
       .use(require('@traptitech/markdown-it-katex'))
 
-    // Custom plugin to add class to <dl> and the last <dd> in each series after a <dt>
-    function addClassToDefinitionList(md) {
-      const originalRender = md.renderer.rules.dl_open || function (tokens, idx, options, env, self) {
-        return self.renderToken(tokens, idx, options);
-      };
-
-      md.renderer.rules.dl_open = function (tokens, idx, options, env, self) {
-        // Add class to <dl>
-        tokens[idx].attrPush(['class', 'terms-and-definitions-list']);
-
-        let lastDdIndex = -1;
-
-        for (let i = idx + 1; i < tokens.length; i++) {
-          if (tokens[i].type === 'dl_close') {
-            // Add class to the last <dd> before closing <dl>
-            if (lastDdIndex !== -1) {
-              const ddToken = tokens[lastDdIndex];
-              const classIndex = ddToken.attrIndex('class');
-              if (classIndex < 0) {
-                ddToken.attrPush(['class', 'last-dd']);
-              } else {
-                ddToken.attrs[classIndex][1] += ' last-dd';
-              }
-            }
-            break;
-          }
-
-          if (tokens[i].type === 'dt_open') {
-            // Add class to the last <dd> before a new <dt>
-            if (lastDdIndex !== -1) {
-              const ddToken = tokens[lastDdIndex];
-              const classIndex = ddToken.attrIndex('class');
-              if (classIndex < 0) {
-                ddToken.attrPush(['class', 'last-dd']);
-              } else {
-                ddToken.attrs[classIndex][1] += ' last-dd';
-              }
-              lastDdIndex = -1; // Reset for the next series
-            }
-          }
-
-          if (tokens[i].type === 'dd_open') {
-            lastDdIndex = i;
-          }
-        }
 
-        return originalRender(tokens, idx, options, env, self);
-      };
-    }
 
     md.use(addClassToDefinitionList);
 
@@ -288,6 +315,14 @@ module.exports = function (options = {}) {
             if (spec.external_specs && !externalReferences) {
               externalReferences = await fetchExternalSpecs(spec);
             }
+
+            // Find the index of the terms-and-definitions-intro.md file
+            const termsIndex = (spec.markdown_paths || ['spec.md']).indexOf('terms-and-definitions-intro.md');
+            if (termsIndex !== -1) {
+              // Append the HTML string to the content of terms-and-definitions-intro.md. This string is used to create a div that is used to insert an alphabet index, and a div that is used as the starting point of the terminology index. The newlines are essential for the correct rendering of the markdown.
+              docs[termsIndex] += '\n\n<div id="alphabet-index-h7vc6omi2hr2880"></div>\n\n<div id="terminology-section-start-h7vc6omi2hr2880"></div>\n\n<hr>\n\n';
+            }
+
             let doc = docs.join("\n");
             doc = applyReplacers(doc);
             md[spec.katex ? "enable" : "disable"](katexRules);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spec-up-t",
-  "version": "1.0.75",
+  "version": "1.0.77",
   "description": "Technical specification drafting tool that generates rich specification documents from markdown. Forked from https://github.com/decentralized-identity/spec-up by Daniel Buchner (https://github.com/csuwildcat)",
   "main": "./index",
   "repository": {

package/src/create-term-index.js

@@ -21,7 +21,7 @@ function createTermIndex() {
     const config = fs.readJsonSync('specs.json');
     const specDirectories = config.specs.map(spec => spec.spec_directory);
     const specTermDirectoryName = config.specs.map(spec => spec.spec_terms_directory);
-    const outputPathJSON = './term-index.json';
+    const outputPathJSON = path.join('output', 'term-index.json');
     const files = fs.readdirSync(path.join(specDirectories[0], specTermDirectoryName[0]))
         .filter(file => !file.startsWith('_'));
 

package/src/fix-markdown-files.js

@@ -2,7 +2,7 @@ const fs = require('fs');
 const path = require('path');
 
 // Function to process markdown files in a directory recursively
-function processMarkdownFiles(directory) {
+function fixMarkdownFiles(directory) {
     // Helper function to process a directory
     function processDirectory(directory) {
         try {
@@ -92,5 +92,5 @@ function processMarkdownFiles(directory) {
 }
 
 module.exports = {
-    processMarkdownFiles
+    fixMarkdownFiles
 };

package/src/get-xrefs-data.js

@@ -92,22 +92,44 @@ async function fetchTermInfoFromGithub(GITHUB_API_TOKEN, xref) {
 
 // Function to fetch the content of a file from a specific commit in a GitHub repository.
 async function fetchFileContentFromCommit(GITHUB_API_TOKEN, owner, repo, commitHash, filePath) {
-    try {
-        const treeUrl = `https://api.github.com/repos/${owner}/${repo}/git/trees/${commitHash}?recursive=1`;
-        const treeResponse = await fetch(treeUrl, { headers: setupFetchHeaders(GITHUB_API_TOKEN) });
-
-        if (treeResponse.ok) {
-            const treeData = await treeResponse.json();
-            const file = treeData.tree.find(item => item.path === filePath);
-            if (file) {
-                const fileContentResponse = await fetch(file.url);
-                const fileContentData = await fileContentResponse.json();
-                return Buffer.from(fileContentData.content, 'base64').toString('utf-8');
+    const MAX_RETRIES = 3;
+    let retries = 0;
+
+    while (retries < MAX_RETRIES) {
+        try {
+            const treeUrl = `https://api.github.com/repos/${owner}/${repo}/git/trees/${commitHash}?recursive=1`;
+            const treeResponse = await fetch(treeUrl, { headers: setupFetchHeaders(GITHUB_API_TOKEN) });
+
+            if (treeResponse.ok) {
+                const treeData = await treeResponse.json();
+                const file = treeData.tree.find(item => item.path === filePath);
+                if (file) {
+                    const fileContentResponse = await fetch(file.url);
+                    const fileContentData = await fileContentResponse.json();
+                    if (fileContentData.content) {
+                        return Buffer.from(fileContentData.content, 'base64').toString('utf-8');
+                    } else {
+                        console.error('Error: fileContentData.content is undefined');
+                    }
+                } else {
+                    console.error(`Error: File ${filePath} not found in commit ${commitHash}`);
+                }
+            } else if (treeResponse.status === 403 && treeResponse.headers.get('X-RateLimit-Remaining') === '0') {
+                const resetTime = treeResponse.headers.get('X-RateLimit-Reset');
+                const waitTime = resetTime ? (resetTime - Math.floor(Date.now() / 1000)) * 1000 : 60000;
+                console.warn(`Rate limit exceeded. Retrying in ${waitTime / 1000} seconds...`);
+                await new Promise(resolve => setTimeout(resolve, waitTime));
+                retries++;
+            } else {
+                console.error(`Error: Failed to fetch tree from ${treeUrl}`);
+                break;
             }
+        } catch (error) {
+            console.error(`Error fetching file content: ${error.message}`);
+            break;
         }
-    } catch (error) {
-        console.error(`\n   SPEC-UP-T: Error fetching file content: ${error.message}\n`);
     }
+
     return null;
 }
 

package/src/insert-term-index.js

@@ -1,8 +1,10 @@
 /**
- * Inserts term index into the specification.
+  * Inserts term index into the specification.
  *
- * This function inserts the entries in term-index.json 
- * term directories, and updates the specification with the term index.
+ * This function reads the entries from term-index.json,
+ * processes the term directories, and updates the specification with the term index.
+ * It modifies the markdown paths in the specification and saves the updated specification
+ * to a JSON file in the output directory.
  *
  * @function
  * @name insertTermIndex
@@ -16,13 +18,16 @@
 function insertTermIndex() {
     const fs = require('fs-extra');
     const path = require('path');
-    const config = fs.readJsonSync('./specs.json');
-    const terms = fs.readJsonSync('./term-index.json');
+    const config = fs.readJsonSync(path.join('specs.json'));
+    const terms = fs.readJsonSync(path.join('output', 'term-index.json'));
     const outputPathJSON = path.join('output', 'specs-generated.json');
     let specGenerated = config;
     let markdownPaths = specGenerated.specs[0].markdown_paths;
 
+    // Find the index of the "terms-and-definitions-intro.md" file in the markdown paths
     const index = markdownPaths.indexOf('terms-and-definitions-intro.md');
+    
+    // 
     if (index !== -1) {
         // Insert the items of the "terms" array after the found index
         markdownPaths.splice(index + 1, 0, ...terms);

package/index.spec-up.js

@@ -1,366 +0,0 @@
-
-module.exports = function (options = {}) {
-
-  const {
-    fetchExternalSpecs,
-    validateReferences,
-    findExternalSpecByKey
-  } = require('./references.js');
-  const gulp = require('gulp');
-  const fs = require('fs-extra');
-  const path = require('path');
-  const findPkgDir = require('find-pkg-dir');
-  const modulePath = findPkgDir(__dirname);
-  let config = fs.readJsonSync('./specs.json');
-  let assets = fs.readJsonSync(modulePath + '/src/asset-map.json');
-  let externalReferences;
-  let references = [];
-  let definitions = [];
-
-  const katexRules = ['math_block', 'math_inline']
-  const replacerRegex = /\[\[\s*([^\s\[\]:]+):?\s*([^\]\n]+)?\]\]/img;
-  const replacerArgsRegex = /\s*,+\s*/;
-  const replacers = [
-    {
-      test: 'insert',
-      transform: function (path) {
-        if (!path) return '';
-        return fs.readFileSync(path, 'utf8');
-      }
-    }
-  ];
-
-  function applyReplacers(doc) {
-    return doc.replace(replacerRegex, function (match, type, args) {
-      let replacer = replacers.find(r => type.trim().match(r.test));
-      return replacer ? replacer.transform(...args.trim().split(replacerArgsRegex)) : match;
-    });
-  }
-
-  function normalizePath(path) {
-    return path.trim().replace(/\/$/g, '') + '/';
-  }
-
-  function renderRefGroup(type) {
-    let group = specGroups[type];
-    if (!group) return '';
-    let html = Object.keys(group).sort().reduce((html, name) => {
-      let ref = group[name];
-      return html += `
-        <dt id="ref:${name}">${name}</dt>
-        <dd>
-          <cite><a href="${ref.href}">${ref.title}</a></cite>. 
-          ${ref.authors.join('; ')}; ${ref.rawDate}. <span class="reference-status">Status: ${ref.status}</span>.
-        </dd>
-      `;
-    }, '<dl class="reference-list">')
-    return `\n${html}\n</dl>\n`;
-  }
-
-  function findKatexDist() {
-    const relpath = "node_modules/katex/dist";
-    const paths = [
-      path.join(process.cwd(), relpath),
-      path.join(__dirname, relpath),
-    ];
-    for (const abspath of paths) {
-      if (fs.existsSync(abspath)) {
-        return abspath
-      }
-    }
-    throw Error("katex distribution could not be located");
-  }
-
-  try {
-
-    var toc;
-    var specGroups = {};
-    const noticeTypes = {
-      note: 1,
-      issue: 1,
-      example: 1,
-      warning: 1,
-      todo: 1
-    };
-    const spaceRegex = /\s+/g;
-    const specNameRegex = /^spec$|^spec[-]*\w+$/i;
-    const terminologyRegex = /^def$|^ref$|^xref/i;
-    const specCorpus = fs.readJsonSync(modulePath + '/assets/compiled/refs.json');
-    const containers = require('markdown-it-container');
-    const md = require('markdown-it')({
-      html: true,
-      linkify: true,
-      typographer: true
-    })
-      .use(require('./src/markdown-it-extensions.js'), [
-        {
-          filter: type => type.match(terminologyRegex),
-          parse(token, type, primary) {
-            if (!primary) return;
-            if (type === 'def') {
-              definitions.push(token.info.args);
-              return token.info.args.reduce((acc, syn) => {
-                return `<span id="term:${syn.replace(spaceRegex, '-').toLowerCase()}">${acc}</span>`;
-              }, primary);
-            }
-            else if (type === 'xref') {
-              const url = findExternalSpecByKey(config, token.info.args[0]);
-              const term = token.info.args[1].replace(spaceRegex, '-').toLowerCase();
-              return `<a class="term-reference" data-local-href="#term:${token.info.args[0]}:${term}"
-                href="${url}#term:${term}">${token.info.args[1]}</a>`;
-            }
-            else {
-              references.push(primary);
-              return `<a class="term-reference" href="#term:${primary.replace(spaceRegex, '-').toLowerCase()}">${primary}</a>`;
-            }
-          }
-        },
-        {
-          filter: type => type.match(specNameRegex),
-          parse(token, type, name) {
-            if (name) {
-              let _name = name.replace(spaceRegex, '-').toUpperCase();
-              let spec = specCorpus[_name] ||
-                specCorpus[_name.toLowerCase()] ||
-                specCorpus[name.toLowerCase()] ||
-                specCorpus[name];
-              if (spec) {
-                spec._name = _name;
-                let group = specGroups[type] = specGroups[type] || {};
-                token.info.spec = group[_name] = spec;
-              }
-            }
-          },
-          render(token, type, name) {
-            if (name) {
-              let spec = token.info.spec;
-              if (spec) return `[<a class="spec-reference" href="#ref:${spec._name}">${spec._name}</a>]`;
-            }
-            else return renderRefGroup(type);
-          }
-        }
-      ])
-      .use(require('markdown-it-attrs'))
-      .use(require('markdown-it-chart').default)
-      .use(require('markdown-it-deflist'))
-      .use(require('markdown-it-references'))
-      .use(require('markdown-it-icons').default, 'font-awesome')
-      .use(require('markdown-it-ins'))
-      .use(require('markdown-it-mark'))
-      .use(require('markdown-it-textual-uml'))
-      .use(require('markdown-it-sub'))
-      .use(require('markdown-it-sup'))
-      .use(require('markdown-it-task-lists'))
-      .use(require('markdown-it-multimd-table'), {
-        multiline: true,
-        rowspan: true,
-        headerless: true
-      })
-      .use(containers, 'notice', {
-        validate: function (params) {
-          let matches = params.match(/(\w+)\s?(.*)?/);
-          return matches && noticeTypes[matches[1]];
-        },
-        render: function (tokens, idx) {
-          let matches = tokens[idx].info.match(/(\w+)\s?(.*)?/);
-          if (matches && tokens[idx].nesting === 1) {
-            let id;
-            let type = matches[1];
-            if (matches[2]) {
-              id = matches[2].trim().replace(/\s+/g, '-').toLowerCase();
-              if (noticeTitles[id]) id += '-' + noticeTitles[id]++;
-              else noticeTitles[id] = 1;
-            }
-            else id = type + '-' + noticeTypes[type]++;
-            return `<div id="${id}" class="notice ${type}"><a class="notice-link" href="#${id}">${type.toUpperCase()}</a>`;
-          }
-          else return '</div>\n';
-        }
-      })
-      .use(require('markdown-it-prism'))
-      .use(require('markdown-it-toc-and-anchor').default, {
-        tocClassName: 'toc',
-        tocFirstLevel: 2,
-        tocLastLevel: 4,
-        tocCallback: (_md, _tokens, html) => toc = html,
-        anchorLinkSymbol: '§',
-        anchorClassName: 'toc-anchor'
-      })
-      .use(require('@traptitech/markdown-it-katex'))
-
-    async function render(spec, assets) {
-      try {
-        noticeTitles = {};
-        specGroups = {};
-        console.log('Rendering: ' + spec.title);
-        return new Promise(async (resolve, reject) => {
-          Promise.all((spec.markdown_paths || ['spec.md']).map(_path => {
-            return fs.readFile(spec.spec_directory + _path, 'utf8').catch(e => reject(e))
-          })).then(async docs => {
-            const features = (({ source, logo }) => ({ source, logo }))(spec);
-            if (spec.external_specs && !externalReferences) {
-              externalReferences = await fetchExternalSpecs(spec);
-            }
-            let doc = docs.join("\n");
-            doc = applyReplacers(doc);
-            md[spec.katex ? "enable" : "disable"](katexRules);
-            const render = md.render(doc);
-            fs.writeFile(path.join(spec.destination, 'index.html'), `
-              <!DOCTYPE html>
-              <html lang="en">
-                <head>
-                  <meta charset="utf-8">
-                  <meta http-equiv="X-UA-Compatible" content="IE=edge">
-                  <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
-      
-                  <title>${spec.title}</title>
-
-                  <link href="https://fonts.googleapis.com/css2?family=Heebo:wght@300;400&display=swap" rel="stylesheet">
-
-                  ${assets.head}
-                </head>
-                <body features="${Object.keys(features).join(' ')}">
-                  
-                  ${assets.svg}
-      
-                  <main>
-      
-                    <header id="header" class="panel-header">
-                      <span id="toc_toggle" panel-toggle="toc">
-                        <svg icon><use xlink:href="#svg-nested-list"></use></svg>
-                      </span>
-                      <a id="logo" href="${spec.logo_link ? spec.logo_link : '#_'}">
-                        <img src="${spec.logo}" />
-                      </a>
-                      <span issue-count animate panel-toggle="repo_issues">
-                        <svg icon><use xlink:href="#svg-github"></use></svg>
-                      </span>
-                    </header>
-      
-                    <article id="content">
-                      ${render}
-                    </article>    
-      
-                  </main>
-      
-                  <slide-panels id="slidepanels">
-                    <slide-panel id="repo_issues" options="right">
-                      <header class="panel-header">
-                        <span>
-                          <svg icon><use xlink:href="#svg-github"></use></svg>
-                          <span issue-count></span>
-                        </span>
-                        <span class="repo-issue-toggle" panel-toggle="repo_issues">✕</span>
-                      </header>
-                      <ul id="repo_issue_list"></ul>
-                    </slide-panel>
-      
-                    <slide-panel id="toc">
-                      <header class="panel-header">
-                        <span>Table of Contents</span>
-                        <span panel-toggle="toc">✕</span>
-                      </header>
-                      <div id="toc_list">
-                        ${toc}
-                      </div>
-                    </slide-panel>
-                    
-                  </slide-panels>
-                  <div style="display: none;">
-                    ${externalReferences}
-                  </div>
-                </body>
-                <script>window.specConfig = ${JSON.stringify(spec)}</script>
-                ${assets.body}
-              </html>
-            `, function (err, data) {
-              if (err) {
-                reject(err);
-              }
-              else {
-                resolve();
-              }
-            });
-            validateReferences(references, definitions, render);
-            references = [];
-            definitions = [];
-          });
-        });
-      }
-      catch (e) {
-        console.error(e);
-      }
-    }
-
-    config.specs.forEach(spec => {
-      spec.spec_directory = normalizePath(spec.spec_directory);
-      spec.destination = normalizePath(spec.output_path || spec.spec_directory);
-
-      fs.ensureDirSync(spec.destination);
-
-      let assetTags = {
-        svg: fs.readFileSync(modulePath + '/assets/icons.svg', 'utf8') || ''
-      };
-
-      let customAssets = (spec.assets || []).reduce((assets, asset) => {
-        let ext = asset.path.split('.').pop();
-        if (ext === 'css') {
-          assets.css += `<link href="${asset.path}" rel="stylesheet"/>`;
-        }
-        if (ext === 'js') {
-          assets.js[asset.inject || 'body'] += `<script src="${asset.path}" ${asset.module ? 'type="module"' : ''} ></script>`;
-        }
-        return assets;
-      }, {
-        css: '',
-        js: { head: '', body: '' }
-      });
-
-      if (options.dev) {
-        assetTags.head = assets.head.css.map(_path => `<link href="${_path}" rel="stylesheet"/>`).join('') +
-          customAssets.css +
-          assets.head.js.map(_path => `<script src="${_path}"></script>`).join('') +
-          customAssets.js.head;
-        assetTags.body = assets.body.js.map(_path => `<script src="${_path}" data-manual></script>`).join('') +
-          customAssets.js.body;
-      }
-      else {
-        assetTags.head = `
-          <style>${fs.readFileSync(modulePath + '/assets/compiled/head.css', 'utf8')}</style>
-          ${customAssets.css}
-          <script>${fs.readFileSync(modulePath + '/assets/compiled/head.js', 'utf8')}</script>
-          ${customAssets.js.head}
-        `;
-        assetTags.body = `<script>${fs.readFileSync(modulePath + '/assets/compiled/body.js', 'utf8')}</script>
-                          ${customAssets.js.body}`;
-      }
-
-      if (spec.katex) {
-        const katexDist = findKatexDist();
-        assetTags.body += `<script>/* katex */${fs.readFileSync(path.join(katexDist, 'katex.min.js'),
-          'utf8')}</script>`;
-        assetTags.body += `<style>/* katex */${fs.readFileSync(path.join(katexDist, 'katex.min.css'),
-          'utf8')}</style>`;
-
-        fs.copySync(path.join(katexDist, 'fonts'), path.join(spec.destination, 'fonts'));
-      }
-
-      if (!options.nowatch) {
-        gulp.watch(
-          [spec.spec_directory + '**/*', '!' + path.join(spec.destination, 'index.html')],
-          render.bind(null, spec, assetTags)
-        )
-      }
-
-      render(spec, assetTags).then(() => {
-        if (options.nowatch) process.exit(0)
-      }).catch(() => process.exit(1));
-
-    });
-
-  }
-  catch (e) {
-    console.error(e);
-  }
-
-}

package/src/prepare-tref.js

@@ -1,7 +0,0 @@
-function prepareTref(tref) {
-
-
-
-}
-
-module.export = { prepareTref };