Commit 2cf6ea78 authored by Rieks Joosten's avatar Rieks Joosten

added `glossaryText` header item in preparation for improved glossary generation

parent 356d2f66
Pipeline #16923 passed with stage
in 2 minutes and 8 seconds
......@@ -6,6 +6,7 @@ type: concept
typeid: conceptID
stage: draft
hoverText: "ConceptID: popuptext for 'conceptID' (tbd)."
glossaryText: "popuptext for 'conceptID' (tbd)."
---
<!--A concept tries to capture the idea behind a classification of entities, allowing us to reason about everything in the class as if it were one thing. This file specifies the idea(s) that, within the scope of `<existing-scopeID>` will be referred to using `<New Term>`.
Please fill in the placeholders in this file as follows:
......
......@@ -6,6 +6,7 @@ type: dictionary
typeid: dictionaryID
stage: draft
hoverText: "DictionaryID: popuptext for 'dictionaryID' (tbd)."
glossaryText: "popuptext for 'dictionaryID' (tbd)."
---
<!--A dictionary is an alphabetically sorted list of terms with associated meanings that originate from multiple scopes.
This template lets you define the specifications according to which a specific dictionary is generated.
......
......@@ -6,6 +6,7 @@ type: glossary
typeid: glossaryID
stage: draft
hoverText: "GlossaryID: popuptext for 'glossaryID' (tbd)."
glossaryText: "popuptext for 'glossaryID' (tbd)."
---
<!--A glossary is an alphabetically sorted list of terms with (short) explanations, usually aimed to help people understand texts around a certain (set of) topic(s) in some context(s).
Please fill in the placeholders in this file as follows:
......
......@@ -6,6 +6,7 @@ type: pattern
typeid: patternID
stage: draft
hoverText: "PatternID: popuptext for 'patternID' (tbd)."
glossaryText: "popuptext for 'patternID' (tbd)."
---
<!-- A pattern captures/describes a set of concepts, relations between them, and rules or constraints that (instances) thereof comply with. As such, it is a concise and possibly formal description of a coherent set of ideas, a mental model if you will, that can be used to facilitate one's thinking about/with these concepts.
Please fill in the placeholders in this file as follows:
......
......@@ -6,6 +6,7 @@ type: scope
typeid: scopeID
stage: draft
hoverText: "ScopeID: popuptext for 'scopeID' (tbd)."
glossaryText: "popuptext for 'scopeID' (tbd)."
---
<!--A scope is something within which concepts can be associated with terms, thereby creating a vocabulary that can be used to meaningfully express ideas, arguments, etc.
Please fill in the placeholders in this file as follows:
......
......@@ -6,6 +6,7 @@ type: type
typeid: typeID
stage: draft
hoverText: "TypeID: popuptext for 'typeID' (tbd)."
glossaryText: "popuptext for 'typeID' (tbd)."
---
<!--This template specifies the docusaurus attribtues that must be in place for the terminology-plugin to function properly. For specific generators, additional content may be required. That should be specified in the individual templates that specify the artifacts that such generators create.
The header-attributes contain the following placeholdes:
......
......@@ -6,6 +6,7 @@ type: concept
typeid: action-type
stage: draft
hoverText: "Action Type/Class: the specification of properties and characteristics that that Actions must have to qualify as instance of that class; also: the set of Actions that actually have these properties and characteristics."
glossaryText: "the specification of properties and characteristics that that %Actions% must have to qualify as instance of that class; also: the set of %Actions% that actually have these properties and characteristics."
---
:::info Editor's note
......
......@@ -6,6 +6,7 @@ type: concept
typeid: action
stage: draft
hoverText: "Action: something that is actually done/executed - by a single Actor (on behalf of a given Party), as a single operation in a specific context."
glossaryText: "something that is actually done/executed - by a single %Actor% (on behalf of a given %Party%), as a single operation in a specific context."
---
### Short Description
......
......@@ -6,6 +6,7 @@ type: concept
typeid: actor
stage: draft
hoverText: "Actor: Entity that can act (do things), e.g. people, machines, but not Organizations."
glossaryText: "Entity that can act (do things), e.g. people, machines, but not %Organizations%."
---
### Short Description
......
......@@ -6,6 +6,7 @@ type: concept
typeid: agent
stage: draft
hoverText: "Agent (of a Party): an Actor that is executing an Action on behalf of a Party (called the Principal of that Actor)."
glossaryText: "an %Actor% that is executing an %Action% on behalf of a %Party% (called the %Principal% of that %Actor%)."
---
### Short Description
......
......@@ -6,6 +6,7 @@ type: concept
typeid: assertion
stage: draft
hoverText: "Assertion: a declaration/statement, made by a specific Party, that something is the case."
glossaryText: "a declaration/statement, made by a specific %Party%, that something is the case."
---
:::info Editor's note
......
......@@ -6,6 +6,7 @@ type: concept
typeid: author
stage: draft
hoverText: "Author (of data/document/file/...): a Party, on whose behalf that data/document/file/... has been created and/or updated."
glossaryText: "a %Party%, on whose behalf that data/document/file/... has been created and/or updated."
---
:::info Editor's note
......
......@@ -6,6 +6,7 @@ type: concept
typeid: business-transaction
stage: draft
hoverText: "Business Transaction: the exchange of goods, services, funds, or data between some Parties (called Participants of the Transaction)."
glossaryText: "the exchange of goods, services, funds, or data between some %Parties% (called %Participants% of the %Transaction%)."
---
import useBaseUrl from '@docusaurus/useBaseUrl'
......
......@@ -6,6 +6,7 @@ type: concept
typeid: colleague
stage: draft
hoverText: "Colleagues: two or more (digital or non-digital) Agents that have the same Principal (i.e. Party on whose behalf they exeucte Actions)."
glossaryText: "two or more (digital or non-digital) %Agents% that have the same %Principal% (i.e. %Party% on whose behalf they exeucte %Actions%)."
---
:::info Editor's note
......
......@@ -6,6 +6,7 @@ type: concept
typeid: commitment-decision
stage: draft
hoverText: "Commitment Decision (of a Party in a Business Transaction): the decision of that Party whether or not to commit to that Business Transaction, i.e. (promise) to fulfill the obligations that the associated Business Transaction Agreement Proposal would impose on that Party once it were signed."
glossaryText: "the decision of that %Party% whether or not to commit to that %Business Transaction%, i.e. (promise) to fulfill the obligations that the associated %Business Transaction Agreement Proposal% would impose on that %Party% once it were signed."
---
:::info Editor's note
......
......@@ -6,6 +6,7 @@ type: concept
typeid: communication-channel
stage: draft
hoverText: "Communication Channel: a (digital or non-digital) means by which two Actors can exchange messages with one another."
glossaryText: "a (digital or non-digital) means by which two %Actors% can exchange messages with one another."
---
:::info Editor's note
......
......@@ -6,6 +6,7 @@ type: concept
typeid: communication-session
stage: draft
hoverText: "Communication Session: a time interval during which two Actors have an established Communication Channel that does not exist outside of that time interval."
glossaryText: "a time interval during which two %Actors% have an established %Communication Channel% that does not exist outside of that time interval."
---
:::info Editor's note
......
......@@ -6,6 +6,7 @@ type: concept
typeid: concept-file
stage: draft
hoverText: "Concept-file: a file whose contents defines/specifies a Concept."
glossaryText: "a file whose contents defines/specifies a %Concept%."
---
### Short Description
......
......@@ -6,6 +6,7 @@ type: concept
typeid: concept
stage: draft
hoverText: "Concept: the ideas/thoughts behind a classification of Entities (what makes Entities in that class 'the same')."
glossaryText: "the ideas/thoughts behind a classification of %Entities% (what makes %Entities% in that class 'the same')."
---
### Short Description
......
......@@ -6,6 +6,7 @@ type: concept
typeid: corpus
stage: draft
hoverText: "Corpus (of Terminology): the documentation that describes the Knowledge around a set of Terms and Concepts."
glossaryText: "the documentation that describes the %Knowledge% around a set of %Terms% and %Concepts%."
---
:::info Editor's note
......
......@@ -6,6 +6,7 @@ type: concept
typeid: credential-catalogue
stage: draft
hoverText: "Credential Catalogue (functional component): the capability to register and advertise the information about Credential Types that their respective Governing Parties have decided to disclose so as to enable other Parties to decide whether or not it is beneficial for them to use Credentials of such types."
glossaryText: "the capability to register and advertise the information about %Credential Types% that their respective %Governing Parties% have decided to disclose so as to enable other %Parties% to decide whether or not it is beneficial for them to use %Credentials% of such types."
---
:::info Editor's note
......
......@@ -6,6 +6,7 @@ type: concept
typeid: credential-type
stage: draft
hoverText: "Credential Type: the specification of the contents, properties, constraints etc. that Credentials of this type must have/comply with."
glossaryText: "the specification of the contents, properties, constraints etc. that %Credentials% of this type must have/comply with."
---
### Short Description
......
......@@ -6,6 +6,7 @@ type: concept
typeid: credential
stage: draft
hoverText: "Credential: data, representing a set of Assertions (claims, statements), authored and signed by, or on behalf of, a specific Party."
glossaryText: "data, representing a set of %Assertions% (claims, statements), authored and signed by, or on behalf of, a specific %Party%."
---
### Short Description
......
......@@ -6,6 +6,7 @@ type: concept
typeid: data-collector-policy
stage: draft
hoverText: "Data Collector Policy: a Digital Policy that enables an operational Data Collector component to function according to the rules of its Policy Governor."
glossaryText: "a %Digital Policy% that enables an operational %Data Collector% component to function according to the rules of its %Policy Governor%."
---
### Short Description
......
......@@ -6,6 +6,7 @@ type: concept
typeid: data-collector
stage: draft
hoverText: "Data Collector: a functional component that is capable of collecting data from various Parties in the context of some Business Transaction, and Validating this data for the purpose of making one (or more) decision(s)."
glossaryText: "a functional component that is capable of collecting data from various %Parties% in the context of some %Business Transaction%, and %Validating% this data for the purpose of making one (or more) decision(s)."
---
### Short Description
......
......@@ -6,6 +6,7 @@ type: concept
typeid: data-discloser-policy
stage: draft
hoverText: "Data Discloser Policy: a Digital Policy that enables an operational Data Discloser component to function according to the rules of its Policy Governor."
glossaryText: "a %Digital Policy% that enables an operational %Data Discloser% component to function according to the rules of its %Policy Governor%."
---
### Short Description
......
......@@ -6,6 +6,7 @@ type: concept
typeid: data-discloser
stage: draft
hoverText: "Data Discloser: a functional component that is capable of disclosing data to (Agents of) other Parties, e.g. in the form of Credentials."
glossaryText: "a functional component that is capable of disclosing data to (Agents of) other %Parties%, e.g. in the form of %Credentials%."
---
### Short Description
......
......@@ -6,6 +6,7 @@ type: concept
typeid: definition
stage: draft
hoverText: "Definition: a text that helps Parties to understand the meaning of (and Concepts behind) a Term, ideally in such a way that these Parties can determine whether or not they make the same distinction."
glossaryText: "a text that helps %Parties% to understand the meaning of (and %Concepts% behind) a %Term%, ideally in such a way that these %Parties% can determine whether or not they make the same distinction."
---
### Short Description
......
......@@ -6,6 +6,7 @@ type: concept
typeid: dependent
stage: draft
hoverText: "Dependent (of an Party in a Jurisdiction): the Entity for the caring for and/or protecting/guarding/defending of which a Guardianship Relationship has been established with that Entity within that Jurisdiction."
glossaryText: "the %Entity% for the caring for and/or protecting/guarding/defending of which a %Guardianship Relationship% has been established with that %Entity% within that %Jurisdiction%."
---
:::info Editor's Note
......
......@@ -6,6 +6,7 @@ type: dictionary
typeid: dictionary-file
stage: draft
hoverText: "Dictionary-file: a file whose contents specifies the contents of a Dictionary."
glossaryText: "a file whose contents specifies the contents of a %Dictionary%."
---
### Short Description
......
......@@ -6,6 +6,7 @@ type: concept
typeid: dictionary
stage: draft
hoverText: "Dictionary: an alphabetically sorted list of Terms with various meanings they may have in different contexts."
glossaryText: "an alphabetically sorted list of %Terms% with various meanings they may have in different contexts."
---
### Short Description
......
......@@ -7,6 +7,7 @@ typeid: digital-actor
conceptref: ":Actor"
stage: draft
hoverText: "Digital Actor: an Actor in the digital world (e.g. a running app, or a web-server)."
glossaryText: "an %Actor% in the digital world (e.g. a running app, or a web-server)."
---
### Purpose
......
......@@ -7,6 +7,7 @@ typeid: digital-agent
conceptref: ":Agent"
stage: draft
hoverText: "Digital Agent: an Agent in the digital world (e.g. a running app, or a web-server that is executing an Action for a specific Party (its Principal))."
glossaryText: "an %Agent% in the digital world (e.g. a running app, or a web-server that is executing an %Action% for a specific %Party% (its %Principal%))."
---
### Purpose
......
......@@ -7,6 +7,7 @@ typeid: digital-colleague
conceptref: ":Colleague"
stage: draft
hoverText: "Digital Colleagues: two or more Digital Agents that all have the same Principal (i.e. Party on whose behalf they exeucte Actions)."
glossaryText: "two or more %Digital Agents% that all have the same %Principal% (i.e. %Party% on whose behalf they exeucte %Actions%)."
---
### Purpose
......
......@@ -6,6 +6,7 @@ type: concept
typeid: digital-communication-channel
stage: draft
hoverText: "Digital Communication Channel: a digital means by which two Digital Actors can exchange messages with one another"
glossaryText: "a digital means by which two %Digital Actors% can exchange messages with one another"
---
:::info Editor's note
......
......@@ -7,6 +7,7 @@ typeid: digital-policy
conceptref: ":Policy"
stage: draft
hoverText: "Digital Policy (of a Party, for Action types): a machine-readable Policy that enables Digital Agents whose Principal is the Policy's Governor, to execute Actions of such types in compliance with that Policy (i.e.: according to the rules, working-instructions, preferences and other guidance specified therein)."
glossaryText: "a machine-readable %Policy% that enables %Digital Agents% whose %Principal% is the %Policy%'s %Governor%, to execute %Actions% of such types in compliance with that %Policy% (i.e.: according to the rules, working-instructions, preferences and other guidance specified therein)."
---
:::info Editor's note
......
......@@ -6,6 +6,7 @@ type: concept
typeid: documentation-interop
stage: draft
hoverText: "Documentation Interoperability: the property that a documentation system of making its content comprehensible for a variety of people that come from different backgrounds."
glossaryText: "the property that a documentation system of making its content comprehensible for a variety of people that come from different backgrounds."
---
:::info Editor's note
......
......@@ -6,6 +6,7 @@ type: scope
typeid: eSSIFLab
stage: draft
hoverText: "ESSIFLab: specification of the eSSIF-Lab scope."
glossaryText: "specification of the eSSIF-Lab scope."
---
### Governance
......
......@@ -6,6 +6,7 @@ type: concept
typeid: employee
stage: draft
hoverText: "Employee (of a Party): an Actor for whom/which it is realistic that it might execute Actions on behalf of that Party (called the Employer of that Actor)."
glossaryText: "an %Actor% for whom/which it is realistic that it might execute %Actions% on behalf of that %Party% (called the %Employer% of that %Actor%)."
---
:::info Editor's note
......
......@@ -6,6 +6,7 @@ type: concept
typeid: employer
stage: draft
hoverText: "Employer (of an Actor): a Party on whose behalf this Actor (called an Employee of that Party) might execute Actions."
glossaryText: "a %Party% on whose behalf this %Actor% (called an %Employee% of that %Party%) might execute %Actions%."
---
:::info Editor's note
......
......@@ -6,6 +6,7 @@ type: concept
typeid: entity
stage: draft
hoverText: "Entity: something that is known to exist."
glossaryText: "something that is known to exist."
---
### Short Description
......
......@@ -6,6 +6,7 @@ type: concept
typeid: essif-glue
stage: draft
hoverText: "eSSIF-Glue: interface layer that allows components with Transaction Data Collector and/or Transaction Data Discloser functionality to use the Wallet, Holder, Issuer and Verifier functionalities."
glossaryText: "interface layer that allows components with %Transaction Data Collector% and/or %Transaction Data Discloser% functionality to use the %Wallet%, %Holder%, %Issuer% and %Verifier% functionalities."
---
### Short Description
......
......@@ -6,6 +6,7 @@ type: glossary
typeid: glossary-file
stage: draft
hoverText: "Glossary-file: a file whose contents defines/specifies a Glossary."
glossaryText: "a file whose contents defines/specifies a %Glossary%."
---
### Short Description
......
......@@ -6,6 +6,7 @@ type: concept
typeid: glossary
stage: draft
hoverText: "Glossary: an alphabetically sorted list of Terms with the (single) meaning it has in (at least) one context."
glossaryText: "an alphabetically sorted list of %Terms% with the (single) meaning it has in (at least) one context."
---
### Short Description
......
......@@ -6,6 +6,7 @@ type: concept
typeid: governance
stage: draft
hoverText: "Governance: the act or process of governing or overseeing the control and direction of something (Merriam-Webster)."
glossaryText: "the act or process of governing or overseeing the control and direction of something (Merriam-Webster)."
---
### Short Description
......
......@@ -6,6 +6,7 @@ type: concept
typeid: governor
stage: draft
hoverText: "Governor: the role that a Party assumes as it is governing or overseeing the control and direction of something."
glossaryText: "the role that a %Party% assumes as it is governing or overseeing the control and direction of something."
---
### Short Description
......
......@@ -6,6 +6,7 @@ type: concept
typeid: guardian
stage: draft
hoverText: "Guardian (of an Entity in a Jurisdiction): the Party that is tasked to care for and/or protect/guard/defend that Entity, for the purpose of which a Guardianship Relationship has been established within that Jurisdiction."
glossaryText: "the %Party% that is tasked to care for and/or protect/guard/defend that %Entity%, for the purpose of which a %Guardianship Relationship% has been established within that %Jurisdiction%."
---
:::info Editor's Note
......
......@@ -6,6 +6,7 @@ type: concept
typeid: guardianship-type
stage: draft
hoverText: "Guardianship-type (in a Jurisdiction): a class of Guardianships (relationships) within the Jurisdiction that has defined it."
glossaryText: "a class of %Guardianships% (relationships) within the %Jurisdiction% that has defined it."
---
### Short Description
......
......@@ -6,6 +6,7 @@ type: concept
typeid: guardianship
stage: draft
hoverText: "Guardianship (of a Party over an Entity in a Jurisdiction): the rights and duties of that Party, defined and enforced in that Jurisdiction, for the purpose of caring for and/or protecting/guarding/defending that Entity."
glossaryText: "the rights and duties of that %Party%, defined and enforced in that %Jurisdiction%, for the purpose of caring for and/or protecting/guarding/defending that %Entity%."
---
:::info Editor's Note
......
......@@ -6,6 +6,7 @@ type: concept
typeid: holder-policy
stage: draft
hoverText: "Holder Policy: a Digital Policy that enables an operational Holder component to function according to the rules of its Policy Governor."
glossaryText: "a %Digital Policy% that enables an operational %Holder% component to function according to the rules of its %Policy Governor%."
---
:::info Editor's note
......
......@@ -6,6 +6,7 @@ type: concept
typeid: holder
stage: draft
hoverText: "Holder (functional component): the capability to handle presentation requests from a Peer Agent, produce the requested data (a presentation) according to its Principal's holder-policy, and send that in response to the request."
glossaryText: "the capability to handle presentation requests from a %Peer Agent%, produce the requested data (a presentation) according to its %Principal%'s holder-policy, and send that in response to the request."
---
### Short Description
......
......@@ -6,6 +6,7 @@ type: concept
typeid: identifier
stage: draft
hoverText: "Identifier: a character string that is being used for the identification of some Entity (yet may refer to 0, 1, or more Entities, depending on the context within which it is being used)."
glossaryText: "a character string that is being used for the identification of some %Entity% (yet may refer to 0, 1, or more %Entities%, depending on the context within which it is being used)."
---
### Short Description
......
......@@ -6,6 +6,7 @@ type: concept
typeid: issuer-policy
stage: draft
hoverText: "Issuer Policy: a Digital Policy that enables an operational Issuer component to function according to the rules of its Policy Governor."
glossaryText: "a %Digital Policy% that enables an operational %Issuer% component to function according to the rules of its %Policy Governor%."
---
:::info Editor's note
......
......@@ -6,6 +6,7 @@ type: concept
typeid: issuer
stage: draft
hoverText: "Issuer (functional component): the capability to construct Credentials from data objects, according to the content of its Principal's Issuer-Policy (specifically regarding the way in which the Credential is to be digitally signed), and pass it to the Wallet-component of its Principal allowing it to be issued."
glossaryText: "the capability to construct %Credentials% from data objects, according to the content of its %Principal%'s %Issuer%-Policy (specifically regarding the way in which the %Credential% is to be digitally signed), and pass it to the %Wallet%-component of its %Principal% allowing it to be issued."
---
:::info Editor's note
......
......@@ -6,6 +6,7 @@ type: concept
typeid: jurisdiction-governor
stage: draft
hoverText: "Governor (of a Jurisdiction): the Party that operates the Legal System of that Jurisdiction."
glossaryText: "the %Party% that operates the %Legal System% of that %Jurisdiction%."
---
:::info Editor's note
......
......@@ -6,6 +6,7 @@ type: concept
typeid: jurisdiction
stage: draft
hoverText: "Jurisdiction: the composition of a Legal System (legislation, enforcement thereof, and conflict resolution), a Party that governs that Legal System, a scope within which that Legal System is operational, and one or more Objectives for the purpose of which the Legal System is operated."
glossaryText: "the composition of a %Legal System% (legislation, enforcement thereof, and conflict resolution), a %Party% that governs that %Legal System%, a scope within which that %Legal System% is operational, and one or more %Objectives% for the purpose of which the %Legal System% is operated."
---
### Short Description
......
......@@ -6,6 +6,7 @@ type: concept
typeid: knowledge-governor
stage: draft
hoverText: "Governor (of a Knowledge): the Party that is 1-1 associated with that knowledge."
glossaryText: "the %Party% that is 1-1 associated with that knowledge."
---
:::info Editor's note
......
......@@ -6,6 +6,7 @@ type: concept
typeid: knowledge
stage: draft
hoverText: "Knowledge: The (intangible) sum of what is known by a specific Party, as well as the familiarity, awareness or understanding of someone or something by that Party."
glossaryText: "The (intangible) sum of what is known by a specific %Party%, as well as the familiarity, awareness or understanding of someone or something by that %Party%."
---
### Short Description
......
......@@ -6,6 +6,7 @@ type: term
typeid: legal-entity
stage: draft
hoverText: "Legal Entity (of a Jurisdiction): an Entity that is known by, recognized to exist, and registered in that Jurisdiction."
glossaryText: "an %Entity% that is known by, recognized to exist, and registered in that %Jurisdiction%."
---
### Short Description
......
......@@ -7,6 +7,7 @@ typeid: legal-jurisdiction
conceptref: essifLab:jurisdiction
stage: draft
hoverText: "Legal Jurisdiction: a Jurisdiction that is governed/operated by a governmental body."
glossaryText: "a %Jurisdiction% that is governed/operated by a governmental body."
---
### Short Description
......
......@@ -6,6 +6,7 @@ type: concept
typeid: legal-system
stage: draft
hoverText: "Legal-system: a system in which rules are defined, and mechanisms for their enforcement and conflict resolution are (implicitly or explicitly) specified."
glossaryText: "a system in which rules are defined, and mechanisms for their enforcement and conflict resolution are (implicitly or explicitly) specified."
---
### Short Description
......
......@@ -7,6 +7,7 @@ typeid: mental-model
conceptref: essifLab:pattern
stage: draft
hoverText: "Mental Model: a casual and formal description (Pattern) of a set of Concepts, relations between them, and constraints, that provide a specific 'viewpoint', or 'way of thinking' about a certain topic."
glossaryText: "a casual and formal description (Pattern) of a set of %Concepts%, relations between them, and constraints, that provide a specific 'viewpoint', or 'way of thinking' about a certain topic."
---
:::info Editor's note
......
......@@ -6,6 +6,7 @@ type: concept
typeid: objective
stage: draft
hoverText: "Objective: Something toward which a Party directs effort (an aim, goal, or end of action)."
glossaryText: "Something toward which a %Party% directs effort (an aim, goal, or end of action)."
---