@oslo-flanders/html-respec-generator
v0.0.16-alpha.0
Published
Generates an HTML respec file using an OSLO-compliant RDF file
Downloads
494
Readme
OSLO HTML ReSpec Generator
Given an OSLO-compliant RDF file, this tool generates an HTML file with the ReSpec layout
Note
This tool has not been thoroughly tested and is primarily used as a visual validation tool!
Install
npm install @oslo-flanders/html-respec-generator
Global install
To use the service from the command line anywhere, you can install it globally.
npm install -g @oslo-flanders/html-respec-generator
API
The service is executed from the CLI and expects the following parameters:
| Parameter | Description | Required | Possible values |
| --------- | --------- | ----------- | --------------- |
| --input
| The URL or local file path of an OSLO-compliant RDF file | :heavy_check_mark: ||
| --output
| The name of the output file | No, defaults to context.jsonld
||
| --specificationType
| The type of specification | No, defaults to Vocabulary
| ApplicationProfile
or Vocabulary
|
| --specificationName
| Title of the document | No ||
| --language
| The language in which the HTML file must be generated (labels) | :heavy_check_mark: ||
| --silent
| Suppress log messages | No | true
or false
(default) |
Usage
oslo-generator-respec --input https://data.vlaanderen.be/ns/adresregister/context.jsonld --language nl
oslo-generator-respec --input report.jsonld --language nl --specificationType ApplicationProfile --specificationName "OSLO-Verkeersmetingen"