Skip to content

Commit

Permalink
migration trajectory done
Browse files Browse the repository at this point in the history
Signed-off-by: henkvancann <[email protected]>
  • Loading branch information
henkvancann committed Nov 12, 2024
1 parent 99e191d commit 5ef0d84
Show file tree
Hide file tree
Showing 11 changed files with 1,969 additions and 2,734 deletions.
4,524 changes: 1,852 additions & 2,672 deletions package-lock.json

Large diffs are not rendered by default.

61 changes: 22 additions & 39 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,16 +1,28 @@
{
"name": "spec-up",
"version": "0.10.6",
"name": "spec-up-t",
"version": "1.0.64",
"description": "Technical specification drafting tool that generates rich specification documents from markdown.",
"main": "./index",
"repository": {
"type": "git",
"url": "git+https://github.com/decentralized-identity/spec-up.git"
},
"scripts": {
"edit": "node -e \"require('./index')()\"",
"render": "node -e \"require('./index')({ nowatch: true })\"",
"dev": "node -e \"require('./index')({ dev: true })\""
"edit": "node -e \"require('spec-up-t')()\"",
"render": "node --no-warnings -e \"require('spec-up-t')({ nowatch: true })\"",
"dev": "node -e \"require('spec-up-t')({ dev: true })\"",
"xrefs": "GITHUB_API_TOKEN=$(grep GITHUB_API_TOKEN .env | cut -d '=' -f2) node -e \"require('spec-up-t/src/get-xrefs-data.js').getXrefsData(process.env.GITHUB_API_TOKEN)\"",
"removexref": "node remove-xref.js",
"topdf": "node -e \"require('spec-up-t/src/create-pdf.js')\"",
"validatespec": "node -e \"require('spec-up-t/src/json-key-validator.js').runJsonKeyValidatorSync()\"",
"addterms": "node -e \"require('spec-up-t/src/create-term-index.js').createTermIndex()\"",
"freeze": "node -e \"require('spec-up-t/src/freeze.js')\"",
"references": "node -e \"require('spec-up-t/src/references.js')\"",
"help": "cat help.txt",
"menu": "bash ./main.sh",
"postinstall": "npm run --silent postinstall:final",
"postinstall:final": "node postinstall-message.js",
"publish": "node -e \"require('spec-up-t/src/create-term-index.js').createTermIndex()\" && node -e \"require('spec-up-t/src/create-pdf.js')\" && GITHUB_API_TOKEN=$(grep GITHUB_API_TOKEN .env | cut -d '=' -f2) node -e \"require('spec-up-t/src/get-xrefs-data.js').getXrefsData(process.env.GITHUB_API_TOKEN)\" && node -e \"require('spec-up-t')({ nowatch: true })\""
},
"keywords": [
"spec",
Expand All @@ -19,43 +31,14 @@
"editor",
"standards"
],
"author": "Daniel Buchner",
"author": "Henk van Cann",
"license": "Apache 2.0",
"bugs": {
"url": "https://github.com/decentralized-identity/spec-up/issues"
"url": "https://github.com/trustoverip/spec-up-t/issues"
},
"homepage": "https://github.com/decentralized-identity/spec-up#readme",
"homepage": "https://github.com/trustoverip/spec-up-t#readme",
"dependencies": {
"@traptitech/markdown-it-katex": "3.3.0",
"axios": "0.21.2",
"find-pkg-dir": "2.0.0",
"fs-extra": "8.1.0",
"gulp": "4.0.2",
"gulp-clean-css": "4.3.0",
"gulp-concat": "2.6.1",
"gulp-terser": "1.2.0",
"markdown-it": "13.0.1",
"markdown-it-anchor": "5.2.5",
"markdown-it-attrs": "4.1.4",
"markdown-it-chart": "^0.2.0",
"markdown-it-container": "^2.0.0",
"markdown-it-deflist": "^2.1.0",
"markdown-it-icons": "^0.4.1",
"markdown-it-ins": "^2.0.0",
"markdown-it-mark": "^2.0.0",
"markdown-it-modify-token": "1.0.2",
"markdown-it-multimd-table": "^4.1.3",
"markdown-it-prism": "^2.2.0",
"markdown-it-references": "1.0.0-alpha.10",
"markdown-it-sub": "^1.0.0",
"markdown-it-sup": "^1.0.0",
"markdown-it-task-lists": "2.1.1",
"markdown-it-textual-uml": "0.1.3",
"markdown-it-toc-and-anchor": "4.2.0",
"merge-stream": "2.0.0",
"pkg-dir": "4.2.0",
"prismjs": ">=1.24.0",
"spec-up": "^0.10.7",
"yargs": "16.2.0"
"dotenv": "^16.4.5",
"spec-up-t": "^1.0.8"
}
}
6 changes: 3 additions & 3 deletions spec/60_terms_and_definitions.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
## Terms and definitions

[[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.
A Specification has enough [[ref: normative]] statements to be directly implementatable.

[[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)

[[def: phrase]]
Expand Down
3 changes: 2 additions & 1 deletion spec/terms-definitions/abbrev.md
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.
24 changes: 16 additions & 8 deletions spec/terms-definitions/alias.md
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 |
3 changes: 2 additions & 1 deletion spec/terms-definitions/doctag.md
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
6 changes: 3 additions & 3 deletions spec/terms-definitions/guide.md
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.
5 changes: 3 additions & 2 deletions spec/terms-definitions/normative.md
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)
2 changes: 1 addition & 1 deletion spec/terms-definitions/phrase.md
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]].
9 changes: 6 additions & 3 deletions spec/terms-definitions/term.md
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).
60 changes: 59 additions & 1 deletion specs.json
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
}
]
}

0 comments on commit 5ef0d84

Please sign in to comment.