Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@ElisabethDeVries
ElisabethDeVries committed Nov 20, 2023
1 parent e3935a5 commit f446a09
Showing 1 changed file with 30 additions and 35 deletions.
65 changes: 30 additions & 35 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,24 +1,46 @@
# NLCS
Deze repository is de locatie voor technische documentatie en het inbrengen en opvolgen van gebruikerswensen voor NLCS, de Nederlandse CAD standaard van DigiGO.

STATUS: Deze repository is in opbouw.
## Beheer

## Actuele versie
* [Beheerdocument DigiGO](https://www.bimloket.nl//documents/Beheerdocument_open_BIM-standaarden_v1_8.pdf)
* [Beheerorganisatie NLCS](https://www.bimloket.nl/p/434/Organisatie-beheer)
* [Beheerhandleiding NLCS](https://nl-digigo.github.io/NLCS/managementmanual)
* [Releaseprotocol NLCS](https://nl-digigo.github.io/NLCS/releaseprotocol)
* [Gebruikerswens indienen](https://github.com/nl-digigo/NLCS/issues)
* [Protocol afhandelen gebruikerswensen](https://github.com/nl-digigo/NLCS/blob/main/instructies/RASCI%20Github%20issues%20NLCS.pdf).

### SQL
## Voor ontwerpers en tekenaars
* [Uitleg standaard](https://nl-digigo.github.io/NLCS/functionalspecification): Functionele specificatie van NLCS met daarin de toelichting op het beoogd doel en de werking van de standaard
* [Tekeningen en modellen maken](https://nl-digigo.github.io/NLCS/requirementscadmodels/)
* [Voorbeeldtekeningen](https://www.nl-digigo.nl/p/432/Leren-van-anderen)

### Zelf applicatie inrichten
Voor gebruikers die zelf hun CAD applicatie inrichten, is de publicatie van NLCS is ook beschikbaar in tabellen:
* [Laagtabellen](https://github.com/nl-digigo/NLCS/tree/main/tabellen)


## Voor softwareleveranciers en ontwikkelaars
* [Eisen aan de software-implementatie van NLCS](https://nl-digigo.github.io/NLCS/requirementssoftware/)
* [Toelichting informatiemodel](https://nl-digigo.github.io/NLCS/code_documentation/): De toelichting op de uitgangspunten en modelleringswijze van het informatiemodel in linked data
* [Toelichting code, datasets, query's](https://nl-digigo.github.io/NLCS/howtoquery/): Een gebruikershandleiding voor gebruik van de linked data publicatie, met toelichting op de code van het informatiemodel, query's en beschikbare datasets
* [Relaties tot andere standaarden](https://nl-digigo.github.io/NLCS/ontologyalignments/): documentatie van de ontology alignments (mappings waar een computer mee kan redeneren) of voorbereidingen daartoe met andere standaarden, waaronder IMGeo (voor BGT kaartinformatie) en het GWSW (Gemeentelijk woordenboek stedelijk water)
* [Uitwisselafspraken](https://nl-digigo.github.io/NLCS/representations/): Nu nog slechts een gebruikerswens. Een nader te bepalen set afspraken over de uitwisseling van modellen en tekeningen in open formaten, met daaraan toegevoegd objectinformatie

### Actuele versie

#### SQL
De ingang naar de SQL database is https://www.nlcs-documentatie.nl/NLCS_5.x_5.0.0/NLCS_5.0.0/start.php.

Hier zit een database achter en PhP code om dit te benaderen/ beschikbaar te maken in Excel via https://www.bimloket.nl/p/452/Database-NLCS


### LinkedData
#### LinkedData
NLCS is bezig met de overgang van een sql database naar een linked data platform. We hebben inmiddels een concept gepubliceerd met deze static URL: https://hub.laces.tech/digitalbuildingdata/nlcs/acceptance/nlcs-acceptatie/versions/v5_0 of deze dynamic url voor als u altijd de laatste versie wilt opvragen: https://hub.laces.tech/digitalbuildingdata/nlcs/acceptance/nlcs-acceptatie. Dit concept zou een weergave moeten zijn van de laatste release van NLCS zoals die in de aloude bekende database stond. Zie ook de [Viewer Concept-publicatie NLCS 5.0](https://nl-digigo.github.io/ld-viewer/nlcs/)

We zijn nog bezig een viewer te maken en documentatie over het informatiemodel, welke is gebaseerd op het topmodel in de de NEN 2660-2. We zijn ook voornemens om sparql-queries te publiceren op github, zodat niet iedereen het wiel hoeft uit te vinden.

### CSV
De publicatie van NLCS is ook beschikbaar in CSV tabellen:
* [Laagtabellen](https://github.com/nl-digigo/NLCS/tree/main/tabellen)


### Symbolen, lijntypes, arceringen, font
De symbolen, lijntypes en arceringen die in de software kunnen worden ingeladen:
Expand All @@ -27,37 +49,10 @@ De symbolen, lijntypes en arceringen die in de software kunnen worden ingeladen:
* [Arceringen](https://github.com/nl-digigo/NLCS/tree/main/arcering)
* [Font](https://github.com/nl-digigo/NLCS/tree/main/font)

### Onderdelen van de standaard
![Architectuur van de standaard](<NLCS architectuur.png>)

## Beheer

* [Beheerdocument DigiGO](https://www.bimloket.nl//documents/Beheerdocument_open_BIM-standaarden_v1_8.pdf)
* [Beheerorganisatie NLCS](https://www.bimloket.nl/p/434/Organisatie-beheer)
* [Beheerhandleiding NLCS](https://nl-digigo.github.io/NLCS/managementmanual)
* [Releaseprotocol NLCS](https://nl-digigo.github.io/NLCS/releaseprotocol)

### Gebruikerswensen

Gebruikers kunnen hun wensen of vragen voor aanpssingen of uitbreidingen van NLCS plaatsen door een issue aan te maken of te reageren op issues van anderen.

* [Gebruikerswens indienen](https://github.com/nl-digigo/NLCS/issues)

Issues worden afgehandeld volgens [dit protocol](https://github.com/nl-digigo/NLCS/blob/main/instructies/RASCI%20Github%20issues%20NLCS.pdf).

## Technische documentatie
De technische documentatie staat nu nog op de [website van DigiGO](https://www.bimloket/p/429/Documentatie) en zal het komende jaar vervangen worden door ReSpecs op deze repo.
![Architectuur van de standaard](<NLCS architectuur.png>)

* [Uitleg standaard](https://nl-digigo.github.io/NLCS/functionalspecification): Functionele specificatie van NLCS met daarin de toelichting op het beoogd doel en de werking van de standaard
* [Toelichting informatiemodel](https://nl-digigo.github.io/NLCS/code_documentation/): De toelichting op de uitgangspunten en modelleringswijze van het informatiemodel in linked data
* [Toelichting code, datasets, query's](https://nl-digigo.github.io/NLCS/howtoquery/): Een gebruikershandleiding voor gebruik van de linked data publicatie, met toelichting op de code van het informatiemodel, query's en beschikbare datasets
* [Relaties tot andere standaarden](https://nl-digigo.github.io/NLCS/ontologyalignments/): documentatie van de ontology alignments (mappings waar een computer mee kan redeneren) of voorbereidingen daartoe met andere standaarden, waaronder IMGeo (voor BGT kaartinformatie) en het GWSW (Gemeentelijk woordenboek stedelijk water)
* [Uitwisselafspraken](https://nl-digigo.github.io/NLCS/representations/): Nu nog slechts een gebruikerswens. Een nader te bepalen set afspraken over de uitwisseling van modellen en tekeningen in open formaten, met daaraan toegevoegd objectinformatie

## Implementatie
* [Tekeningen en modellen maken](https://nl-digigo.github.io/NLCS/requirementscadmodels/)
* [Software-implementatie van NLCS](https://nl-digigo.github.io/NLCS/requirementssoftware/)
* [Voorbeeldtekeningen](https://www.nl-digigo.nl/p/432/Leren-van-anderen)

![Documentatie van de standaard](<NLCS documentatie.png>)

Expand Down

0 comments on commit f446a09

Please sign in to comment.