@oslo-flanders/html-generator v1.0.4

OSLO HTML Generator

Given an OSLO Webuniversum JSON file, this tool generates an HTML file with the HTML layout

Install

npm install @oslo-flanders/html-generator

Global install

To use the service from the command line anywhere, you can install it globally.

npm install -g @oslo-flanders/html-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-webuniversum config | :heavy_check_mark: || | --output | The name of the output file | No, defaults to index.html || | --stakeholders | The URL or local file path to the stakeholders json | :heavy_check_mark: || | --metadata | The URL or local file path of the metadata config file | :heavy_check_mark: || | --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) | | --templates | path to local folder containing different templates that can be used for extending the root template | | | | --rootTemplate | Use a different template other than the default ones (ap2.j2 and voc2.j2) | No | |

Sidenote

For the application profile from OSLO we use a function to generate our anchor tags. The anchor tags are formed based on the available label of each entity and/or the available label of the property. If the label is not available, we use the URI of the entity or property. The final result gets encoded using the encodeURIComponent function. The function can be found here.

Usage

oslo-generator-html --input webuniversum-config.json --language nl --stakeholders stakeholders.json --metadata metadata.json
oslo-generator-html --input webuniversum-config.json --language nl --specificationType ApplicationProfile --specificationName "OSLO-Verkeersmetingen" --stakeholders stakeholders.json --metadata metadata.json
oslo-generator-html --input webuniversum-config.json --language nl --specificationType ApplicationProfile --specificationName "OSLO-Verkeersmetingen" --stakeholders stakeholders.json --metadata metadata.json
oslo-generator-html --input ./webuniversum-config.json --language nl --stakeholders ./stakeholders.json --metadata ./metadata.json --specificationName "OSLO-verkeersmetingen" --specificationType Vocabulary --templates ./templates --rootTemplate vrachtwagenParkeren-voc.njk