Skip to content

Commit

Permalink
word2werkversie toegevoegd
Browse files Browse the repository at this point in the history
  • Loading branch information
wilkoquak committed Feb 19, 2024
1 parent 6560287 commit 9fa0061
Show file tree
Hide file tree
Showing 8 changed files with 51 additions and 28 deletions.
20 changes: 18 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,27 @@
# Handleiding GitHub

Modelleurs bij Geonovum werken met verschillende tools. In deze repository verzamelen we alle handleidingen die binnen Geonovum beschikbaar zijn. De documentatie is in MarkDown geschreven en gebruikt een wrapper van mkdocs.
Modelleurs bij Geonovum werken met verschillende tools. In deze repository
verzamelen we alle handleidingen die binnen Geonovum beschikbaar zijn. De
documentatie is in MarkDown geschreven en gebruikt een wrapper van mkdocs.

### HTML-versie

Een html-versie van de handleiding is te vinden op [github pages](https://geonovum.github.io/handleiding-tooling/)

### Lokaal serveren

Navigeer via de Command Line Interface (CLI) naar de lokale map waarin het bestand `mkdocs.yml` staat. Als je deze folder lokaal hebt staan kan je met het commando `mkdocs serve` een locale webserver starten en live kijken hoe de document eruitziet in je [browser](http://127.0.0.1:8000/). Om `mkdocs serve` uit te kunnen voeren, heb je **Python** nodig. [Kijk hier voor de _requirements_ voor mkdocs](https://www.mkdocs.org/user-guide/installation/#requirements). Als je [Python via www.python.org installeert](https://wiki.python.org/moin/BeginnersGuide/Download), hoef je pip niet meer apart te installeren. Als je klaar bent, druk je de toetsencombinatie `CTRL` + `C` in de CLI om de server uit te zetten.
Als je op je eigen laptop de handleiding wilt wijzigen kun je live de gegevens
serveren:
- Check deze repository lokaal uit.
- Installeer de mkdocs software.
- Ga in je command shell naar de folder waarin mkdocx.yml staat.
- Type 'mkdocs serve'.
- Nu draait er een locale webserver en via je browser zie je live de wijzigingen op: [browser](http://127.0.0.1:8000/).

Om `mkdocs serve` uit te kunnen voeren, heb je **Python** nodig. [Kijk hier voor de
_requirements_ voor
mkdocs](https://www.mkdocs.org/user-guide/installation/#requirements). Als je
[Python via www.python.org
installeert](https://wiki.python.org/moin/BeginnersGuide/Download), hoef je pip
niet meer apart te installeren. Als je klaar bent, druk je de toetsencombinatie
`CTRL` + `C` in de CLI om de server uit te zetten.
8 changes: 4 additions & 4 deletions docs/EA.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ Instructie voor het gebruik van Enterprise Architect binnen Geonovum:

## Installatie

- [Enterprise Architect](https://www.sparxsystems.eu/) is via de website te downloaden.
>
> TODO
>
- 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

Expand Down
10 changes: 5 additions & 5 deletions docs/MIM-toolbox-genereren.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Handleiding - MIM-Profiel, -Toolbox & -MDG Genereren

| Software/Standaard | Versie |
| --- | ---: |
| MIM-standaard | 1.1.1 |
| Enterprise Architect | 15.2 |
| Subversion (SVN) | 1.14.1 |
| Software/Standaard | Versie |
| -------------------- | -----: |
| MIM-standaard | 1.1.1 |
| Enterprise Architect | 15.2 |
| Subversion (SVN) | 1.14.1 |

## Inhoud
1. [Voorbereiding](#1-voorbereiding)
Expand Down
10 changes: 4 additions & 6 deletions docs/Markdown.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Dit kan je ook in een snelkoppeling zetten als icoon op de desktop.

### Firefox

In Firefox kan je dat instellen via de parameters.
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)

Expand All @@ -34,11 +34,9 @@ In de adresbalk: about:config, dan het risico aanvaarden, en deze parameter vera
| [Visual Studio Code](https://code.visualstudio.com/) | Fijne teksteditor die ook goed integreert met Github Desktop |
| [PowerToys](https://learn.microsoft.com/en-us/windows/powertoys/) | Geeft preview van Markdown rechtstreeks in Windows Explorer (en nog heeel veel andere tooltjes) |
| [Tables Generator](https://www.tablesgenerator.com/markdown_tables) | Helpt met het maken van tabellen in MarkDown |
| [Markdown Table](https://marketplace.visualstudio.com/items?itemName=TakumiI.markdowntable) | VSCode plugin voor het editen van Markdown tabellen. |
| [Markdown Table](https://marketplace.visualstudio.com/items?itemName=TakumiI.markdowntable) | VSCode plugin voor het editen van Markdown tabellen. |
| [Prettier](https://prettier.io/) | Een code formatter die automatisch zorgt dat je markdown aan de regels voldoet. |
| [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. |
| [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 zou in `.mdlintrc` of de configuratie van Prettier kunnen.
22 changes: 12 additions & 10 deletions docs/SVN-installeren-voor-EAP.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,29 @@



Informatiemodellen staan idealiter onder **Subversion**. Dit is de versiebeheertool die we bij Geonovum gebruiken. Het voordeel van versiebeheer is dat we gemeenschappelijk kunnen werken aan één model en de wijzigingen daarvan op één plek bijhouden. Deze handleiding beschrijft hoe je een informatiemodel in de versiebeheeromgeving zet.
UML modellen worden beheerd in **Subversion (SVN)** op 'svn.geostandaarden.nl'. Dit is een versiebeheertool die kan samenwerken met 'Enterprise Architect' en wordt daarom voor UML modellen gebruik.. Deze handleiding beschrijft hoe je een informatiemodel in de versiebeheeromgeving zet.

Dit document bevat de volgende onderdelen:

- [Voorbereiding: Installeer SVN Tortoise op pc.](#voorbereiding-installeer-svn-tortoise-op-pc)
- [Stap 1: Folder aanmaken op SVN-server](#stap-1-folder-aanmaken-op-svn-server)
- [Stap 2: Lokale folder aanmaken](#stap-2-lokale-folder-aanmaken)
- [Stap 3: Lokale folder koppelen aan folder op SVN-server](#stap-3-lokale-folder-koppelen-aan-folder-op-svn-server)
- [Stap 4: Breng EAP-bestand(packages) onder SVN.](#stap-4-breng-eap-bestandpackages-onder-svn)
- [Stap 5: Breng package onder version control](#stap-5-breng-package-onder-version-control)
- [Stap 6: Check package in of uit](#stap-6-check-package-in-of-uit)
- [Meer informatie](#meer-informatie)
1. Voorbereiding: Installeer SVN Tortoise vraag een account aan.
1. Folder aanmaken op SVN-server.
1. Lokale folder aanmaken.
1. Lokale folder koppelen aan folder op SVN-server.
1. Breng EAP-bestand(packages) onder SVN.
1. Breng package onder version control.
1. Check package in of uit.
1. Meer informatie.

### Voorbereiding: Installeer SVN Tortoise op pc.
### Voorbereiding: Installeer SVN Tortoise en vraag account aan

Als je **SVN Tortoise** nog niet hebt, installeer deze van
<https://tortoisesvn.net/>.

> **Note**
> Installeer ook de _**Command Line Client Tools**_ mee. Dit heb je nodig bij [stap 4: Breng EAP-bestand (packages) onder SVN](#stap-4-breng-eap-bestand-packages-onder-svn). Het is een extra optie en valt niet onder de standaardinstallatie, dus je moet hier zelf alert op zijn. Het is ook mogelijk om dit achteraf te doen. Hoe je dit doet, staat beschreven in stap 4.
Vraag een account aan voor svn.geostandaarden.nl bij 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=R30VuV)

### Stap 1: Folder aanmaken op SVN-server

- Maak een folder op de SVN-server (`svn.geostandaarden.nl`) aan met de naam van het model.
Expand Down
4 changes: 4 additions & 0 deletions docs/WordConversies.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# MsWord conversies

Er zijn tools om MsWord documenten om te zetten naar Mardown:
- [Word2Werkversie](https://geonovum.github.io/word2werkversie_handleiding/).
2 changes: 2 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ Welkom bij de beschrijving van de Geonovum Werkwijze. Deze helpfiles beschrijven
- [GML](GML.md): Toelichting GML, XSD en Namespaces.
- **Ontologie**
- [Ontologie](Handleiding-ontologie-maken-en-publiceren.md): Handleiding voor het maken en publiceren van een ontologie.
- **Word Conversies**
- [Word2werkversie](WordConversies.md)

Voor licenties of de interne beheerder van de tooling kun je terecht op [intranet](https://stichtinggeonovum.sharepoint.com/:b:/r/sites/FBICT/Gedeelde%20documenten/General/wat%20staat%20waar/Tooling_en_Beheerders.pdf?csf=1&web=1&e=aEcKjl)

Expand Down
3 changes: 2 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ repo_url: https://github.com/Geonovum/handleiding-tooling
edit_uri: blob/main/docs/
nav:
- Home:
- 'Index': index.md
- 'Welkom': index.md
- 'Geonovum Werkwijze Modelleren': geonovum-werkwijze-modelleren.md
- 'Werkomgeving Modelleren': werkomgeving-modelleren.md
- 'Werkwijze Modelleren': werkwijze-modelleren.md
Expand All @@ -30,3 +30,4 @@ nav:
- 'SVN importeren bestaand project': SVN-importeren-bestaand-project.md
- GML: GML.md
- Ontologie: Handleiding-ontologie-maken-en-publiceren.md
- WordConversies: WordConversies.md

0 comments on commit 9fa0061

Please sign in to comment.