forked from trustoverip/ctwg-terminology-governance-guide
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: henkvancann <[email protected]>
- Loading branch information
1 parent
99e191d
commit 5ef0d84
Showing
11 changed files
with
1,969 additions
and
2,734 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,5 @@ | ||
[[def: abbrev, abbreviation]] | ||
|
||
~ a shorthand in capitals for a [[ref: term]]. It may contain special characters. It may not contain spaces. | ||
Criterium for not being an abbreviation: If the word is not in uppercase, in our context the word is more likely to be an [[ref: alias]] for the term. | ||
|
||
~ Criterium for not being an abbreviation: If the word is not in uppercase, in our context the word is more likely to be an [[ref: alias]] for the term. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,19 @@ | ||
[[def: alias]] | ||
|
||
~ Any notation of a terminology item, that is an alternative for a term being defined. The alias also serves as a comparison among term definitions. | ||
An alias is typically a means to one-on-one relate specific wording to a term already defined. For example : | ||
- Synonyms | ||
- Plural - singular | ||
- Different spelling | ||
- Lowercase versus Uppercase | ||
- another (!) abbreviation | ||
*Mind you: the most applicable abbreviation should be in [[ref:abbrev]].* | ||
Criterium: an alias | TBW | | ||
|
||
~ An alias is typically a means to one-on-one relate specific wording to a term already defined. For example : | ||
|
||
~ - Synonyms | ||
|
||
~ - Plural - singular | ||
|
||
~ - Different spelling | ||
|
||
~ - Lowercase versus Uppercase | ||
|
||
~ - another (!) abbreviation | ||
|
||
~ *Mind you: the most applicable abbreviation should be in [[ref:abbrev]].* | ||
|
||
~ Criterium: an alias | TBW | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,3 @@ | ||
[[def: doctag]] | ||
~ A short unique tag assigned to the remote Spec-Up document containing the def for the term being referenced. So any Spec-Up document that uses remote refs would need to include a doctag section | ||
|
||
~ A short unique tag assigned to the remote Spec-Up document containing the def for the term being referenced. So any Spec-Up document that uses remote refs would need to include a doctag section |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
[[def: Guide, guide, guidelines]] | ||
~ | ||
What is the criterium something being a Guide versus a Specification? | ||
A Specification has enough [[ref: normative]] statements to be directly implementatable. | ||
|
||
~ ~ What is the criterium something being a Guide versus a Specification? | ||
|
||
~ A Specification has enough [[ref: normative]] statements to be directly implementatable. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,5 @@ | ||
[[def: normative]] | ||
~ | ||
A theory is “normative” if it, in some sense, tells you what you should do - what action you should take.Also see [KERISSE](https://weboftrust.github.io/WOT-terms/docs/glossary-unified?level=2#normative) | ||
|
||
~ ~ | ||
|
||
~ A theory is “normative” if it, in some sense, tells you what you should do - what action you should take.Also see [KERISSE](https://weboftrust.github.io/WOT-terms/docs/glossary-unified?level=2#normative) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
[[def: phrase]] | ||
~ Something is a phrase when it's either a [[ref: term]], an [[ref: abbreviation]] or an [[ref: alias]] in the context of this [[ref: guide]]. | ||
|
||
~ Something is a phrase when it's either a [[ref: term]], an [[ref: abbreviation]] or an [[ref: alias]] in the context of this [[ref: guide]]. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,9 @@ | ||
[[def: term]] | ||
|
||
~ The ToIP notation of a terminology item, that requires a definiton, that could have an abbreviation and zero or more aliasses. A term is supposed to be uniquely defined in a certain scope, but can have many exactly the same instances in a broader community. | ||
The term also serves as a key in the source management tool of ToIP terminology sources and to make a comparison among terms. | ||
Criterium: only if a certain word or [[ref: phrase]] in ToIP notation and first placed in the definition tag, then it's a term in the scope of this [[ref: guide]]. Only a term can have just one [[ref:abbreviation]]. | ||
Also see [term](https://weboftrust.github.io/WOT-terms/docs/glossary-unified?level=2#term). | ||
|
||
~ The term also serves as a key in the source management tool of ToIP terminology sources and to make a comparison among terms. | ||
|
||
~ Criterium: only if a certain word or [[ref: phrase]] in ToIP notation and first placed in the definition tag, then it's a term in the scope of this [[ref: guide]]. Only a term can have just one [[ref:abbreviation]]. | ||
|
||
~ Also see [term](https://weboftrust.github.io/WOT-terms/docs/glossary-unified?level=2#term). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,59 @@ | ||
{"specs":[{"title":"ToIP Template Specification","spec_directory":"./spec","output_path":"./docs","markdown_paths":["05_title.md","10_header.md","13_toc.md","16_foreword.md","18_clauses.md","20_introduction.md","24_scope.md","28_design.md","32_howto_define.md","36_roles.md","40_tools_landscape.md","44_style_guide.md","48_source_management.md","52_manual_defsrefs.md","glossary-intro-created-by-split-tool.md","terms-definitions/guide.md","terms-definitions/normative.md","terms-definitions/phrase.md","terms-definitions/term.md","terms-definitions/abbrev.md","terms-definitions/alias.md","terms-definitions/doctag.md","64_audience.md","68_spec-up-improvements.md","72_integration.md","90_annex.md"],"logo":"https://raw.githubusercontent.com/trustoverip/logo-assets/master/logos/ToIP-Logo-Color-SolidDimensional-Horizontal-LightOnDark.svg","logo_link":"https://github.com/trustoverip/specification-template","katex":true,"source":{"host":"github","account":"trustoverip","repo":"specification-template"}}]} | ||
{ | ||
"specs": [ | ||
{ | ||
"title": "Spec-Up-T Starterpack", | ||
"spec_directory": "./spec", | ||
"spec_terms_directory": "terms-definitions", | ||
"output_path": "./docs", | ||
"markdown_paths": [ | ||
"05_title.md", | ||
"10_header.md", | ||
"13_toc.md", | ||
"16_foreword.md", | ||
"18_clauses.md", | ||
"20_introduction.md", | ||
"24_scope.md", | ||
"terms-and-definitions-intro.md", | ||
"28_design.md", | ||
"32_howto_define.md", | ||
"36_roles.md", | ||
"40_tools_landscape.md", | ||
"44_style_guide.md", | ||
"48_source_management.md", | ||
"52_manual_defsrefs.md", | ||
"64_audience.md", | ||
"68_spec-up-improvements.md", | ||
"72_integration.md", | ||
"90_annex.md" | ||
], | ||
"logo": "https://raw.githubusercontent.com/blockchainbird/spec-up-t-starter-pack/main/spec-up-t-starterpack/logo.svg", | ||
"logo_link": "https://github.com/blockchainbird/spec-up-t", | ||
"source": { | ||
"host": "github", | ||
"account": "blockchainbird", | ||
"repo": "spec-up-t-starter-pack" | ||
}, | ||
"external_specs": [ | ||
{ | ||
"test-1": "https://blockchainbird.github.io/spec-up-xref-test-1/" | ||
}, | ||
{ | ||
"test-2": "https://blockchainbird.github.io/spec-up-xref-test-2/" | ||
} | ||
], | ||
"external_specs_repos": [ | ||
{ | ||
"external_spec": "test-1", | ||
"url": "https://github.com/blockchainbird/spec-up-xref-test-1", | ||
"terms_dir": "spec/term-definitions" | ||
}, | ||
{ | ||
"external_spec": "test-2", | ||
"url": "https://github.com/blockchainbird/spec-up-xref-test-2", | ||
"terms_dir": "spec/term-definitions" | ||
} | ||
], | ||
"katex": false | ||
} | ||
] | ||
} |