Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

In the spring of 2024, the CTWG begin publishing the ToIP Glossary as a ToIP specification based on the Spec-Up utility hosted by the Decentralized Identity Foundation. To reference terms defined in the ToIP Glossary, we need to provide permalinks. There are two primary usages for these permalinks:

  1. Any Web document can create a standard Web linnk link directly to the ToIP Glossary as a whole or to any specific term within it.
  2. Any other Spec-Up-based specification can create an xref (external reference) to a term. An xref is more than just a link—it enables the Web version of the document to display a pop-up definition of the term when you hover the link with your mouse cursor.

...

The challenge with permalinks to the ToIP Glossary is that it is a living document. Definitions of terms may evolve over time. After much discussion, the CTWG concluded that this meant means two classes of permalinks must be supported:

...

https://trustoverip.github.io/glossary/yyyymmdd

Where “yyyymmdd” yyyymmdd is the date string consisting of the year—and optionally the month and day—of the version following these rules:

  1. The yyyy string MUST be present.
  2. The yyyy string MAY OPTIONALLY be followed by EITHER a “mmdd” mmdd string OR a “mm” mm string.

The returned version of the ToIP Glossary MUST be the union of the definitions of all terms that existed in the living ToIP Glossary as of the last datetime equal to or earlier than the date string.

...

https://trustoverip.github.io/glossary/vxx

Where “xx” xx is the version number of the version following these rules:

  1. The xx string MUST be present.
  2. The xx string MUST be a positive integer.
  3. The xx string MUST NOT have leading zeros, e.g., it must start at 1.
  4. The vxx xx string MUST be incremented by one for each new version tag, e.g., v1, v2, v3…v439.

...

The CTWG is currently (May/June 2024) evaluating how it can produce the “virtual versions” of the ToIP Glossary as required by these permalink templates. The ideal design will not need to produce create any actual copies of term data, rather “virtual versions” can be produced glossary data (as Spec-Up does when producing different version of a specification document). Instead, it would generate “virtual versions” dynamically from individual term definition files that use standard GitHub git commit tags for versioning. Updates will be posted to this page as soon as we have a conclusion.