Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
…ocabularia into test
  • Loading branch information
jensscheerlinck committed Nov 22, 2018
2 parents 3c62534 + a776b26 commit 210b12b
Show file tree
Hide file tree
Showing 10 changed files with 358 additions and 332 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ De volgende componenten zijn van belang in de pipeline:
* **site-skeleton**
Deze map bevat alle statische assets, zoals figuren of overzichtspagina's van data.vlaanderen.be. De inhoud van deze map wordt zonder aanpassing gekopieerd naar de finale website
* **src**
Deze map bevat alle eap (enterprise architect project) bestanden. Deze bestanden zijn de "bron der waarheid" voor alle vocabularia en applicatieprofielen. Het volstaat een eap file te vervangen om een applicatieprofiel of vocabularium bij te werken. Om nieuwe vocabularia toe te voegen moet de correcte eap file in deze map geplaats worden en de nodige configuratie toegevoegd worden in `config/eap-mapping.json`.
Deze map bevat alle *eap* (enterprise architect project) bestanden en het bestand *stakeholders.csv*. Deze bestanden zijn de "bron der waarheid" voor alle vocabularia en applicatieprofielen. Het volstaat een *eap* file te vervangen om een applicatieprofiel of vocabularium bij te werken. Om een nieuw applicatieprofiel of vocabularium toe te voegen moet de correcte *eap* file in deze map geplaatst worden en de nodige configuratie toegevoegd worden in *config/eap-mapping.json*. Bovendien moeten allicht een nieuwe kolom toegevoegd worden aan *stakeholders.csv*. Zie lager voor meer info over hoe dit te doen.
* **templates**
Deze map bevat de jinja / nunjucks templates voor ieder vocabularium en applicatieprofiel. Dit is de plaats waar de HTML beschrijvingen toegevoegd worden.
* **config**
Expand All @@ -29,6 +29,12 @@ De volgende componenten zijn van belang in de pipeline:
* *shacl-validator-config.json*: Bevat de configuratie van https://data.vlaanderen.be/shacl-validator. De validator laadt deze in vanop de github URL. Indien nieuwe shacl files beschikbaar gemaakt moeten worden aan de validator, moet dit bestand aangepast worden.
* *eap-mapping.json*: Bevat de configuratie van de pipeline zelf.

## `stakeholders.csv` encoding
Dit bestand moet UTF-8 encoded zijn.
* Als je dit bestand in Windows bewerkt met een tekst editor, moet je dus zeker zijn dat deze UTF-8 encoding kan interpreteren en behoudt bij het updaten (gewone Notepad is niet geschikt).
* Als je dit bestand in Windows bewerkt met Excel, hou er dan rekening mee dat Excel standaard met ANSI encoded bestanden werkt. Dus: vooraleer te openen met Excel eerst converteren van UTF-8 naar ANSI en na bewaren in Excel achteraf terug converteren van ANSI naar UTF-8. Kijk meteen het scheidingsteken nog eens na (moet `,` zijn).
* Tip: [Notepad++](https://notepad-plus-plus.org/) is een tekst editor die voldoet aan de voorwaarden om dit bestand rechtstreeks te bewerken. Er zijn ook menu opties om de encoding te verifiëren en te converteren.

## `eap-mapping.json` structuur
De `eap-mapping.json` configuratie is een array met objecten van de volgende vorm.

Expand Down Expand Up @@ -64,7 +70,7 @@ De attributen hebben de volgende betekenis:
* *type*: Geeft aan of het item een vocabularium (`voc`) of applicatieprofiel (`ap`) is.
* *eap*: Is de naam van de eap file waar het te converteren diagramma zich bevindt. Dit is hoofdlettergevoelig en het bestand moet aanwezig zijn in `/src`.
* *diagram*: Is de naam van het diagramma in de eap file dat geconverteerd moet worden. Dit is hoofdlettergevoelig.
* *contributors*: Is de naam van de kolom in `stakeholders_latest.csv` die gebruikt wordt om contributors toe te voegen.
* *contributors*: Is de naam van de kolom in `stakeholders.csv` die gebruikt wordt om contributors toe te voegen.
* *template*: Is de bestandsnaam van de template die gebruikt wordt om de HTML te genereren. Dit bestand moet aanwezig zijn in `/templates`
* *title*: Dit is de titel die getoond wordt in de HTML van een applicatieprofiel. Dit attribuut is niet van toepassing voor vocabularia en wordt genegeerd indien er toch een waarde is. Bepaalt, na conversie naar kleine letters en vervanging van spaties door '-', het pad waar `overview.jpg` gezocht wordt.
* *prefix*: Een optionele prefix voor de url van een vocabularium, afgestemd met de baseURI van het package, gedefinieerd in de eap file. *Zou* ook kunnen gebruikt worden voor een AP, maar dan zou de resulterende jsonld context file niet beschikbaar zijn onder /context.
12 changes: 6 additions & 6 deletions config/eap-mapping.json
Original file line number Diff line number Diff line change
Expand Up @@ -396,13 +396,13 @@
"title": "Besluit Mobiliteit"
},
{
"name": "verkeersbordendatabank",
"name": "verkeersborden",
"type": "ap",
"eap": "OSLO-Verkeersbordendatabank-AP.eap",
"diagram": "OSLO-Mobiliteit_applicatieprofiel_verkeersbordendatabank",
"contributors": "Verkeersbordendatabank",
"template": "verkeersbordendatabank-ap.j2",
"title": "Verkeersbordendatabank"
"eap": "OSLO-Verkeersborden-AP.eap",
"diagram": "OSLO-Mobiliteit_applicatieprofiel_verkeersborden",
"contributors": "Verkeersborden",
"template": "verkeersborden-ap.j2",
"title": "Verkeersborden"
},
{
"name": "vlaamse-codex",
Expand Down
Binary file added site-skeleton/cms/ap/verkeersborden/overview.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file modified src/OSLO-Gebouwenregister-AP.eap
Binary file not shown.
Binary file not shown.
Binary file modified src/OSLO-Vocabularium.eap
Binary file not shown.
Loading

0 comments on commit 210b12b

Please sign in to comment.