Skip to content

Commit

Permalink
respec aangepast
Browse files Browse the repository at this point in the history
  • Loading branch information
wilkoquak committed Feb 27, 2024
1 parent 9fa0061 commit a76493b
Show file tree
Hide file tree
Showing 9 changed files with 540 additions and 271 deletions.
7 changes: 7 additions & 0 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"default": true,
"MD003": { "style": "atx" },
"MD007": { "indent": 4 },
"MD013": { "line_length": 80, "code_blocks": false, "heading_line_length": 200, "tables": false},
"no-hard-tabs": false
}
8 changes: 8 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"tabWidth": 4,
"useTabs": false,
"singleQuote": true,
"endOfLine": "lf",
"proseWrap": "always",
"printWidth": 80
}
75 changes: 48 additions & 27 deletions docs/EA-toepassing-standaarddatatypen.md
Original file line number Diff line number Diff line change
@@ -1,65 +1,86 @@
# EA - Gebruik standaarddatatypes (intern)

> **Note**
> `@Gerard`: screenshots toevoegen
> **Note** > `@Gerard`: screenshots toevoegen
Bij Geonovum gebruiken we een aantal voorgedefineerde datatypes. Deze zijn opgedeeld in drie categorieën:
Bij Geonovum gebruiken we een aantal voorgedefineerde datatypes. Deze zijn
opgedeeld in drie categorieën:

1. MIM11 -- Dit package bevat de datatypes die voorgedefinieerd zijn in het [MIM](https://docs.geostandaarden.nl/mim/mim/)
1. Geonovum geometrie -- Dit package bevat de geometrietypes uit [ISO19107](https://docs.geostandaarden.nl/nen3610/gimeg/). Deze zijn in een los package gestopt zodat andere partijen die alleen geometrie willen gebruik deze types kunnen gebruiken,
1. Geonovum algemeen -- In dit package zitten alle overige datatypes die in Geonovum UML packages gebruikt worden. Merk op dat in dit package ook wat geometrie types zitten; dit zijn types die niet uit ISO-19107 komen. Bij voorkeur worden deze niet in de modellering gebruikt.
1. MIM11 -- Dit package bevat de datatypes die voorgedefinieerd zijn in het
[MIM](https://docs.geostandaarden.nl/mim/mim/)
1. Geonovum geometrie -- Dit package bevat de geometrietypes uit
[ISO19107](https://docs.geostandaarden.nl/nen3610/gimeg/). Deze zijn in een
los package gestopt zodat andere partijen die alleen geometrie willen
gebruik deze types kunnen gebruiken,
1. Geonovum algemeen -- In dit package zitten alle overige datatypes die in
Geonovum UML packages gebruikt worden. Merk op dat in dit package ook wat
geometrie types zitten; dit zijn types die niet uit ISO-19107 komen. Bij
voorkeur worden deze niet in de modellering gebruikt.

In: svn.geostandaarden.nl/Datatypes zijn drie collecties met primitieve types opgenomen die alle primitieve types bevat die in Geonovum UML modellen gebruikt
In: svn.geostandaarden.nl/Datatypes zijn drie collecties met primitieve types
opgenomen die alle primitieve types bevat die in Geonovum UML modellen gebruikt

Deze packages zijn in beheer bij @wilkoquak. Het is de bedoeling dat er in [Imvertor] een mapping komt die precies overeenkomt het deze drie collecties types
Deze packages zijn in beheer bij @wilkoquak. Het is de bedoeling dat er in
[Imvertor] een mapping komt die precies overeenkomt het deze drie collecties
types

## Geometrie datatypes

In dit package zitten de geometrische datatypes zoals genoemd in [ISO19107:2003](https://www.iso.org/standard/26012.html).
In dit package zitten de geometrische datatypes zoals genoemd in
[ISO19107:2003](https://www.iso.org/standard/26012.html).

![Geometrie](media/GML-geometrie.png)

## MIM datatypes

In dit package zitten de geometrische datatypes zoals genoemd in [MIM](https://docs.geostandaarden.nl/mim/mim/#datatypen).
In dit package zitten de geometrische datatypes zoals genoemd in
[MIM](https://docs.geostandaarden.nl/mim/mim/#datatypen).

![MIM](media/MIM11.png)

## Geonovum datatypes

In dit package zitten datatypes die niet in de twee eerdergenoemde packages vallen maar wel ergens gebruikt zijn bij Geonovum.
In dit package zitten datatypes die niet in de twee eerdergenoemde packages
vallen maar wel ergens gebruikt zijn bij Geonovum.

![Geonovum datatypes](media/Geonovum-algemeen.png)

> **Note**
> `@Wilko` wil jij een korte toelichting geven op de driedeling. Wat vind je waar en waarom?
> **Note** > `@Wilko` wil jij een korte toelichting geven op de driedeling. Wat
> vind je waar en waarom?
Alle basic datatypes binnen UML zouden in één van deze packages moeten staan. Als dat niet zo is neem dan contact op met `@Wilko`.
Alle basic datatypes binnen UML zouden in één van deze packages moeten staan.
Als dat niet zo is neem dan contact op met `@Wilko`.

Je vindt ze op SVN: `svn://svn.geostandaarden.nl/Datatypes`:

> **Warning**
> Onderstaande naamgeving klopt niet meer. Dit is door Wilko in overleg aangepast. `@Gerard`: graag updaten!
> **Warning** Onderstaande naamgeving klopt niet meer. Dit is door Wilko in
> overleg aangepast. `@Gerard`: graag updaten!
1. `MIM11.xml`
1. `Geonovum-algemeen.xml`
1. `Geonovum-geometrie.xml`
1. `MIM11.xml`
1. `Geonovum-algemeen.xml`
1. `Geonovum-geometrie.xml`

> **Note**
> Er is nu nog een `Datatyps.xml` waarin alle datatypes zitten deze gaat binnenkort verdwijnen.
> **Note** Er is nu nog een `Datatyps.xml` waarin alle datatypes zitten deze
> gaat binnenkort verdwijnen.
## Datatypes importeren voor gebruik in EA

Lees hoe je deze types als packages importeert in de handleiding [SVN - importeren bestaand project](https://github.com/Geonovum/imvertor/blob/main/handleidingen/SVN%20-%20importeren%20bestaand%20project.md).
Lees hoe je deze types als packages importeert in de handleiding
[SVN - importeren bestaand project](https://github.com/Geonovum/imvertor/blob/main/handleidingen/SVN%20-%20importeren%20bestaand%20project.md).

## Gebruik packages in EA

Deze packages zijn bedoeld voor toepassing binnen een informatiemodel. Het is niet de bedoeling om de packages in of uit te checken; er hoeven immers geen wijzigingen in aangebracht te worden.
Deze packages zijn bedoeld voor toepassing binnen een informatiemodel. Het is
niet de bedoeling om de packages in of uit te checken; er hoeven immers geen
wijzigingen in aangebracht te worden.

> **Note**
> `@Wilko` en `@Paul`: Eigenlijk zou je hier een beperkt aantal mensen schrijfrechten willen geven en de rest alleen lees-rechten. Ik heb zoiets nog niet kunnen vinden. `@Gerart`: je kunt dat instellen door in configuratiebestandjes op svn.geostandaarden.nl, maar dan moet je daar wel bij kunnen.
> **Note** > `@Wilko` en `@Paul`: Eigenlijk zou je hier een beperkt aantal
> mensen schrijfrechten willen geven en de rest alleen lees-rechten. Ik heb
> zoiets nog niet kunnen vinden. `@Gerart`: je kunt dat instellen door in
> configuratiebestandjes op svn.geostandaarden.nl, maar dan moet je daar wel bij
> kunnen.
## Verwijzen naar een datatype

> **Note**
> `@Gerard`: In deze paragraaf een uitleg opnemen hoe je vanuit Enterprise Architect een voorgedefineerd datatype opneemt bij een `«Attribuutsoort»`. |
> **Note** > `@Gerard`: In deze paragraaf een uitleg opnemen hoe je vanuit
> Enterprise Architect een voorgedefineerd datatype opneemt bij een
> `«Attribuutsoort»`. |
23 changes: 9 additions & 14 deletions docs/EA.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,24 +7,19 @@ Instructie voor het gebruik van Enterprise Architect binnen Geonovum:

## Installatie

- Op de website is een proefversie van [Enterprise Architect](https://www.sparxsystems.eu/) te downloaden.
- Neem voor een licentie contact op met de [beheerder](https://stichtinggeonovum.sharepoint.com/:b:/r/sites/FBICT/Gedeelde%20documenten/General/wat%20staat%20waar/Tooling_en_Beheerders.pdf?csf=1&web=1&e=aEcKjl)
- Op de website is een proefversie van
[Enterprise Architect](https://www.sparxsystems.eu/) te downloaden.
- Neem voor een licentie contact op met de
[beheerder](https://stichtinggeonovum.sharepoint.com/:b:/r/sites/FBICT/Gedeelde%20documenten/General/wat%20staat%20waar/Tooling_en_Beheerders.pdf?csf=1&web=1&e=aEcKjl)

## De MIM toolbox

Importeer de MIM toolbox:

## De MIM toolbox
Zie: [MIM toolbox importeren](MIM-toolbox-importeren.md)

Externe links:

Externe links:
- [Handleiding gebruik MIM-toolbox](https://github.com/Geonovum/MIM-Werkomgeving/blob/master/UML%20profieltooling/werkversie1.1.1/README.md)
- [Handleiding genereren MIM-profiel](https://github.com/Geonovum/MIM-Werkomgeving/tree/master/UML%20profieltooling#readme)
- [Handleiding genereren Extensie MIM-toolbox](https://github.com/Geonovum/MIM-Werkomgeving/blob/master/UML%20profieltooling/how_to_extensie_op_toolbox.md)


Stappen:
- Download de MIM Toolbox. Deze is te vinden op: [github](https://github.com/Geonovum/MIM/tree/master/informatiemodel)
- Start Enterprise Architect en open de project browser (Start→Design→Browser)
- Open het resources tabje en klik met de rechtermuis op ‘MDG Technologies’.
- Kies ‘Import Technology’ en importeer de MIM Toolbox.
- Deze is nu zichtbaar onder ‘Model Technologies’:

![MIM toolbox](media/MIM-toolbox.png)
43 changes: 36 additions & 7 deletions docs/Markdown.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,32 @@
# Markdown

Voor het extern publiceren van documenten en standaarden gebruiken we [ReSpec](../ReSpec). Deze tool ondersteunt naast HTML en Javascript ook Markdown
Voor het extern publiceren van documenten en standaarden gebruiken we
[ReSpec](../ReSpec). Deze tool ondersteunt naast HTML en Javascript ook Markdown

[Markdown](https://nl.wikipedia.org/wiki/Markdown) is een lichtgewicht opmaaktaal op basis van platte tekst die zodanig ontworpen is dat het gemakkelijk valt te converteren naar HTML en andere. Markdown wordt vaak gebruikt voor de opmaak van project documentatie (README-bestanden), eenvoudige CMS-systemen en berichten in online fora. Je kunt Markdown in iedere simpele teksteditor bewerken.
[Markdown](https://nl.wikipedia.org/wiki/Markdown) is een lichtgewicht
opmaaktaal op basis van platte tekst die zodanig ontworpen is dat het
gemakkelijk valt te converteren naar HTML en andere. Markdown wordt vaak
gebruikt voor de opmaak van project documentatie (README-bestanden), eenvoudige
CMS-systemen en berichten in online fora. Je kunt Markdown in iedere simpele
teksteditor bewerken.

Het ontwerpdoel van de taal is leesbaarheid. Teksten geschreven met behulp van Markdown worden geacht al leesbaar te zijn voordat opmaak is toegepast op de tekst. Opmaakinstructies en tags zijn dan ook niet te vinden in pure Markdown.
Het ontwerpdoel van de taal is leesbaarheid. Teksten geschreven met behulp van
Markdown worden geacht al leesbaar te zijn voordat opmaak is toegepast op de
tekst. Opmaakinstructies en tags zijn dan ook niet te vinden in pure Markdown.

## Het viewen van Markdown in je broswer

Sommige browsers weigeren het openen van lokale bestanden, of negeren links naar locale bestanden. Dit kun je in de configuratie aanpassen:
Sommige browsers weigeren het openen van lokale bestanden, of negeren links naar
locale bestanden. Dit kun je in de configuratie aanpassen:

### Chrome

Je moet twee dingen instellen:

- Local access: Toestaan dat je local files toont in Chrome, dat is een opstart argument. Kan je doen vanuit een cmd-prompt `%localappdata%\google\chrome\application\chrome --allow-file-access-from-files
- Local access: Toestaan dat je local files toont in Chrome, dat is een opstart
argument. Kan je doen vanuit een cmd-prompt
`%localappdata%\google\chrome\application\chrome
--allow-file-access-from-files
- CORS Toestaan : zelfde soort oplossing: `--disable-web-security`

Dit kan je ook in een snelkoppeling zetten als icoon op de desktop.
Expand All @@ -23,7 +35,9 @@ Dit kan je ook in een snelkoppeling zetten als icoon op de desktop.

In Firefox kan je dat instellen via de parameters.

In de adresbalk: about:config, dan het risico aanvaarden, en deze parameter veranderen: `security.fileuri.strict_origin_policy = false` (dus op false zetten)
In de adresbalk: about:config, dan het risico aanvaarden, en deze parameter
veranderen: `security.fileuri.strict_origin_policy = false` (dus op false
zetten)

## Tools voor Markdown

Expand All @@ -39,4 +53,19 @@ In de adresbalk: about:config, dan het risico aanvaarden, en deze parameter vera
| [mdlint](https://github.com/Laboratoria/mdlint) | Een style checker form markdown bestanden. Geef meldingen voor verkeerde markdown |
| [Live Server](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer) | VSCode plugin. Klik rechtsonder op "Go Live" en je ReSpec doc wordt in live browser geopend. |

> **Note** > `@Wilko`: we kunnen nog styling regels voor markdown vastleggen. Maximale regellengte = 80 bijvoorbeeld. Dit zou in `.mdlintrc` of de configuratie van Prettier kunnen.
> **Note** `@Wilko`: we kunnen nog styling regels voor markdown vastleggen.
> Maximale regellengte = 80 bijvoorbeeld. Dit kan door een `.prettierrc` in de root van
> een project te zetten.
Voorbeeld van '.prettierrc' gebruikt in dit project:

```json
{
"printWidth": 80,
"tabWidth": 2,
"useTabs": false,
"singleQuote": true,
"endOfLine": "lf",
"proseWrap": "always"
}
```
88 changes: 0 additions & 88 deletions docs/ReSpec-Checklists.md

This file was deleted.

Loading

0 comments on commit a76493b

Please sign in to comment.