update documentation

nl-digigo · Sep 27, 2023 · 0485482 · 0485482
1 parent 07e477e
commit 0485482
Show file tree

Hide file tree

Showing 25 changed files with 179 additions and 24 deletions.
diff --git a/docs/code_documentation/index.html b/docs/code_documentation/index.html
@@ -5,7 +5,7 @@
   <meta charset='utf-8'>
   <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
   <!-- Pas hier de titel van het document aan -->
-  <title>Toelichting Informatiemodel NLCS</title>
+  <title>Documentatie Informatiemodel NLCS</title>
   <script src="config.js" class="remove"></script>
   <script src='https://cdn.jsdelivr.net/gh/stichting-crow/respec@latest/builds/respec-stichting-crow.js' async class='remove'></script>
 </head>

diff --git a/docs/functionalspecification/h/5.md b/docs/functionalspecification/h/5.md
@@ -543,14 +543,37 @@ a.	Voor de afmetingen van teksten gelden eisen t.a.v. de hoogte en de lijndikte.
     <td>5.0</td>
     <td>Hoofd- of kleine letters</td>
     <td>Onderstreept</td>
-    <td>DOORSNEDE A-A</td>
+    <td><head>
+    <style>
+        /* CSS-stijl om tekst te onderstrepen en een hoogte van 5 in te stellen */
+        .onderstreept-tekst {
+            text-decoration: underline; /* Hiermee wordt de tekst onderstreept */
+            line-height: 5; /* Hiermee wordt de hoogte van de tekst ingesteld op 5 (kan ook in pixels of andere eenheden zijn) */
+        }
+    </style>
+</head>
+<body>
+    <!-- HTML-element met de class "onderstreept-tekst" -->
+    <p class="onderstreept-tekst">DOORSNEDE A-A</p>
+</body></td>
   </tr>
   <tr>
     <td>Schaalaanduiding</td>
     <td>2.5</td>
     <td>Hoofd- of kleine letters</td>
     <td>Direct onder of naast de modeltitel</td>
-    <td>SCHAAL 1:100</td>
+    <td><head>
+    <style>
+        /* CSS-stijl om tekst te onderstrepen en een hoogte van 5 in te stellen */
+        .schaalaanduiding {
+            line-height: 2,5; /* Hiermee wordt de hoogte van de tekst ingesteld op 5 (kan ook in pixels of andere eenheden zijn) */
+        }
+    </style>
+</head>
+<body>
+    <!-- HTML-element met de class "onderstreept-tekst" -->
+    <p class="schaalaanduiding">SCHAAL 1:100</p>
+</body></td>
   </tr>
   <tr>
     <td>Geografische aanduidingen (plaatsnamen, wijknamen, poldernamen, riviernamen etc.)</td>
@@ -564,28 +587,39 @@ a.	Voor de afmetingen van teksten gelden eisen t.a.v. de hoogte en de lijndikte.
     <td>3.5</td>
     <td>Hoofdletters</td>
     <td></td>
-    <td>N.A.P.</td>
+    <td><head>
+    <style>
+        /* CSS-stijl om tekst te onderstrepen en een hoogte van 5 in te stellen */
+        .drieeneenhalf {
+            line-height: 3,5; /* Hiermee wordt de hoogte van de tekst ingesteld op 5 (kan ook in pixels of andere eenheden zijn) */
+        }
+    </style>
+</head>
+<body>
+    <!-- HTML-element met de class "onderstreept-tekst" -->
+    <p class="drieeneenhalf">N.A.P.</p>
+</body></td>
   </tr>
   <tr>
     <td>Aanduiding chemische stoffen</td>
     <td>3.5</td>
     <td>Hoofdletters zonder puntjes</td>
     <td></td>
-    <td>PVC</td>
+    <td> <p class="drieeneenhalf">PVC</p></td>
   </tr>
   <tr>
     <td>Asnamen</td>
     <td>2.5</td>
     <td>Hoofdletters</td>
     <td></td>
-    <td>ALM A6</td>
+    <td> <p class="schaalaanduiding">ALM A6</p></td>
   </tr>
   <tr>
     <td>Polderpeil, waterpeil, winterpeil en zomerpeil</td>
     <td>2.5</td>
     <td>Kleine letters</td>
     <td></td>
-    <td>zp = -2.60</td>
+    <td><p class="schaalaanduiding">zp = -2.60</p></td>
   </tr>
   <tr>
     <td>Wereldcoördinaten</td>
@@ -599,14 +633,25 @@ a.	Voor de afmetingen van teksten gelden eisen t.a.v. de hoogte en de lijndikte.
     <td>2.5</td>
     <td>Kleine letters, eventueel beginnend met een hoofdletter</td>
     <td>Indien symbolen voor bestaand en nieuw gelijk zijn wordt teksthoogte 1.8 gehanteerd</td>
-    <td>Asfaltverharding</td>
+    <td><p class="schaalaanduiding">Asfaltverharding</p></td>
   </tr>
   <tr>
     <td>Bijschriften t.a.v. bestaande situatie</td>
     <td>1.8</td>
     <td>Kleine letters, cursief</td>
     <td></td>
-    <td>Bestaande band</td>
+    <td><head>
+    <style>
+        /* CSS-stijl om tekst te onderstrepen en een hoogte van 5 in te stellen */
+        .eenpuntacht {
+            line-height: 1,8; /* Hiermee wordt de hoogte van de tekst ingesteld op 5 (kan ook in pixels of andere eenheden zijn) */
+        }
+    </style>
+</head>
+<body>
+    <!-- HTML-element met de class "onderstreept-tekst" -->
+    <p class="eenpuntacht">Bestaande band</p>
+</body></td>
   </tr>
   <tr>
     <td>Teksten voor speciale doeleinden</td>
@@ -668,12 +713,48 @@ e.	  Wanneer diverse kabels naast elkaar worden gepland, mag dit als ‘wenstrac
 <figcaption>Aanhaallijn met aanduiding van vlak op de tekening</caption>
 </figure>
 
+### Benaming tekststijlen 
+a.	In de NLCS komen 2 lettertypes voor, NLCS-RVV voor verkeersborden en NLCS-ISO voor alle andere teksten. De systematiek voor de benaming van tekststijlen in de NLCS is als volgt opgebouwd:
+<p>NLCS-ISO  -[EENHEID SCHAAL]-[TEKSTHOOGTE]_[CURSIEF]
+NLCS-RVV-[EENHEID SCHAAL]-[TEKSTHOOGTE]_[CURSIEF]</p>
 
+Voorbeelden:
+| Stijl                | Beschrijving                                            |
+|----------------------|--------------------------------------------------------|
+| NLCS-ISO             | NLCS tekststijl zonder extra aanduidingen.             |
+| NLCS-ISO-M100_T35    | NLCS tekststijl in meters, schaal 1:100, teksthoogte 3.5.         |
+| NLCS-ISO-MM20-T18_CURSIEF | NLCS tekststijl in millimeters, schaal 1:20, teksthoogte 1.8, tekst cursief. |
+| NLCS-ISO-ANNOTATIEF-T25   | NLCS tekststijl met annotatieve schaal, teksthoogte 2.5.         |
+
+b.	Voor de bijschriften met aanpijling kunnen multileaders worden toegepast. De systematiek voor de benaming van multileaderstijlen in de NLCS is als volgt opgebouwd:
+<p>NLCS-EENHEID SCHAAL-TEKSTHOOGTE_[CURSIEF]-AANPIJLINGSYMBOOL </p>
+
+Toepasbare waarden voor AANPIJLINGSYMBOOL: PIJL (Arrow), BOL (Dot) en OPENBOL.
+
+Voorbeelden:
+| Stijl                       | Beschrijving                                           |
+|-----------------------------|-------------------------------------------------------|
+| NLCS-M100-T25-PIJL          | NLCS multileaderstijl in meters, schaal 1:100, teksthoogte 2.5, pijl als symbool.         |
+| NLCS-MM20-T25_CURSIEF-BOL    | NLCS multileaderstijl in millimeters, schaal 1:20, teksthoogte 2.5, tekst cursief, bol als symbool. |
+| NLCS-ANNOTATIEF-T25-PIJL     | NLCS maatvoeringstijl met teksthoogte 2.5, pijl als symbool, annotatief; in dit geval is de eenheid van de schaal in de naam niet van belang vanwege de annotatieve schaal. |
 
+## Oriëntatieaanduidingen
+a.	Op terreinmodellen moet de oriëntatie ten opzichte van de wereldcoördinaten worden aangeven met een grid van ruitkruisjes. 
+b.	Het ruitkruisje moet volgens onderstaande vorm worden getekend. 
+
+<figure>
+<img src="./h/media/ruitkruisjecompas.png" alt="Grafische weergave van ruitkruisje">
+<figcaption>Ruitkruisje</caption>
+</figure>
 
 
+<figure>
+<img src="./h/media/voorbeeldtekeniggruitkruisje.png" alt="Grafische weergave van tekening met Noordpijl en ruitkruisjes">
+<figcaption>Voorbeeld van tekening met Noordpijl en ruitkruisjes:</caption>
+</figure>
 
 
+d.	De Noordpijl en ruitkruisjes in het bovenstaande voorbeeld zijn ‘schaalonafhankelijke symbolen’. Deze symbolen hebben op een afgedrukte tekening altijd dezelfde afmetingen, onafhankelijk van de voor de tekening gehanteerde schaal. 
 
 
 

diff --git a/docs/functionalspecification/h/media/ruitkruisjecompas.png b/docs/functionalspecification/h/media/ruitkruisjecompas.png
diff --git a/docs/functionalspecification/h/media/verwijzingaanzicht.PNG b/docs/functionalspecification/h/media/verwijzingaanzicht.PNG
diff --git a/docs/howtoquery/config.js b/docs/howtoquery/config.js
@@ -1,8 +1,8 @@
 var respecConfig = {
   // => https://github.com/stichting-crow/respec/wiki
   specStatus: "DRAFT",
-  shortName: "NLCS/releaseprotocol",
-  specType: "beheerdocumentatie", // vrije tekst, kleine letter
+  shortName: "NLCS/howtoquery",
+  specType: "technische documentatie", // vrije tekst, kleine letter
   imprint: "bimloket",
   editors: [
     // alleen `name` is verplicht, https://respec.org/docs/#person

diff --git a/docs/howtoquery/h/0-samenvatting.md b/docs/howtoquery/h/0-samenvatting.md
@@ -1 +1 @@
-Dit document beschrijft het releaseprotocol van NLCS, de stappen die worden ondernomen om te komen tot een nieuwe release
+Dit document is de gebruikershandleiding voor gebruik van de linked data publicatie van NLCS, met toelichting op de code van het informatiemodel, query's en beschikbare datasets
diff --git a/docs/howtoquery/index.html b/docs/howtoquery/index.html
@@ -5,7 +5,7 @@
   <meta charset='utf-8'>
   <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
   <!-- Pas hier de titel van het document aan -->
-  <title>Releaseprotocol</title>
+  <title>Toelichting code, query's en beschikbare datasets</title>
   <script src="config.js" class="remove"></script>
   <script src='https://cdn.jsdelivr.net/gh/stichting-crow/respec@latest/builds/respec-stichting-crow.js' async class='remove'></script>
 </head>

diff --git a/docs/ontologyalignments/config.js b/docs/ontologyalignments/config.js
@@ -1,7 +1,7 @@
 var respecConfig = {
   // => https://github.com/stichting-crow/respec/wiki
   specStatus: "DRAFT",
-  shortName: "NLCS/releaseprotocol",
+  shortName: "NLCS/ontologyalignements",
   specType: "beheerdocumentatie", // vrije tekst, kleine letter
   imprint: "bimloket",
   editors: [

diff --git a/docs/ontologyalignments/index.html b/docs/ontologyalignments/index.html
@@ -5,7 +5,7 @@
   <meta charset='utf-8'>
   <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
   <!-- Pas hier de titel van het document aan -->
-  <title>Releaseprotocol</title>
+  <title>Relaties NLCS met andere standaarden</title>
   <script src="config.js" class="remove"></script>
   <script src='https://cdn.jsdelivr.net/gh/stichting-crow/respec@latest/builds/respec-stichting-crow.js' async class='remove'></script>
 </head>

diff --git a/docs/releaseprotocol/index.html b/docs/releaseprotocol/index.html
@@ -5,7 +5,7 @@
   <meta charset='utf-8'>
   <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
   <!-- Pas hier de titel van het document aan -->
-  <title>Releaseprotocol</title>
+  <title>Releaseprotocol NLCS</title>
   <script src="config.js" class="remove"></script>
   <script src='https://cdn.jsdelivr.net/gh/stichting-crow/respec@latest/builds/respec-stichting-crow.js' async class='remove'></script>
 </head>

diff --git a/docs/representations/config.js b/docs/representations/config.js
@@ -1,8 +1,8 @@
 var respecConfig = {
   // => https://github.com/stichting-crow/respec/wiki
   specStatus: "DRAFT",
-  shortName: "NLCS/releaseprotocol",
-  specType: "beheerdocumentatie", // vrije tekst, kleine letter
+  shortName: "NLCS/representations",
+  specType: "technische documentatie", // vrije tekst, kleine letter
   imprint: "bimloket",
   editors: [
     // alleen `name` is verplicht, https://respec.org/docs/#person

diff --git a/docs/representations/h/0-samenvatting.md b/docs/representations/h/0-samenvatting.md
@@ -1 +1 @@
-Dit document beschrijft het releaseprotocol van NLCS, de stappen die worden ondernomen om te komen tot een nieuwe release
+Nu nog slechts een gebruikerswens.  Dit document beschrijft Een nader te bepalen set afspraken over de uitwisseling van modellen en tekeningen in open formaten, met daaraan toegevoegd objectinformatie
diff --git a/docs/representations/index.html b/docs/representations/index.html
@@ -5,7 +5,7 @@
   <meta charset='utf-8'>
   <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
   <!-- Pas hier de titel van het document aan -->
-  <title>Releaseprotocol</title>
+  <title>Uitwisselafspraken NLCS</title>
   <script src="config.js" class="remove"></script>
   <script src='https://cdn.jsdelivr.net/gh/stichting-crow/respec@latest/builds/respec-stichting-crow.js' async class='remove'></script>
 </head>

diff --git a/docs/requirementscadmodels/config.js b/docs/requirementscadmodels/config.js
@@ -1,8 +1,8 @@
 var respecConfig = {
   // => https://github.com/stichting-crow/respec/wiki
   specStatus: "DRAFT",
-  shortName: "NLCS/releaseprotocol",
-  specType: "beheerdocumentatie", // vrije tekst, kleine letter
+  shortName: "NLCS/requirementscadmodels",
+  specType: "technische documentatie", // vrije tekst, kleine letter
   imprint: "bimloket",
   editors: [
     // alleen `name` is verplicht, https://respec.org/docs/#person

diff --git a/docs/requirementscadmodels/h/0-samenvatting.md b/docs/requirementscadmodels/h/0-samenvatting.md
@@ -1 +1 @@
-Dit document beschrijft het releaseprotocol van NLCS, de stappen die worden ondernomen om te komen tot een nieuwe release
+Dit document beschrijft de eisen van NLCS aan CAD modellen en tekeningen 
diff --git a/docs/requirementscadmodels/index.html b/docs/requirementscadmodels/index.html
@@ -5,7 +5,7 @@
   <meta charset='utf-8'>
   <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
   <!-- Pas hier de titel van het document aan -->
-  <title>Releaseprotocol</title>
+  <title>Eisen aan tekeningen en modellen</title>
   <script src="config.js" class="remove"></script>
   <script src='https://cdn.jsdelivr.net/gh/stichting-crow/respec@latest/builds/respec-stichting-crow.js' async class='remove'></script>
 </head>

diff --git a/docs/requirementssoftware/config.js b/docs/requirementssoftware/config.js
@@ -0,0 +1,43 @@
+var respecConfig = {
+  // => https://github.com/stichting-crow/respec/wiki
+  specStatus: "DRAFT",
+  shortName: "NLCS/requirementssoftware",
+  specType: "technische documentatie", // vrije tekst, kleine letter
+  imprint: "bimloket",
+  editors: [
+    // alleen `name` is verplicht, https://respec.org/docs/#person
+    {
+      name: "Elisabeth de Vries",
+      company: "DigiGO",
+    },
+  ],
+  authors: [
+    // alleen `name` is verplicht, https://respec.org/docs/#person
+    {
+      name: "Corné Helmons",
+      company: "DigiGO",
+    },
+    {
+      name: "Niels Nederpel",
+      company: "DigiGO",
+    },
+  ],
+  github: "https://github.com/bimloket/NLCS",
+  license: "cc-by",
+  lint: { "no-unused-dfns": false },
+  localBiblio: {
+  NEN_2660_2_2022: {
+    title: "NEN 2660-2 Regels voor informatiemodellering van de gebouwde omgeving - Deel 2: Praktische configuratie, extensie en implementatie van NEN 2660-1",
+    href: "https://www.nen.nl/en/nen-2660-2-2022-nl-291667",
+    status: "Actueel",
+    publisher: "NEN",
+  },
+  NEN_2660_1_2022: {
+    title: "NEN 2660-1 Rules for information modelling of the built environment - Part 1: Conceptual models",
+    href: "https://www.nen.nl/en/nen-2660-1-2022-nl-291666",
+    status: "Actueel",
+    publisher: "NEN",
+  },
+
+  },
+};
diff --git a/docs/requirementssoftware/h/0-samenvatting.md b/docs/requirementssoftware/h/0-samenvatting.md
@@ -0,0 +1 @@
+Dit document beschrijft de eisen aan software-implementatie, de voorwaarden om NLCS-leverancier te kunnen zijn
diff --git a/docs/requirementssoftware/h/1.md b/docs/requirementssoftware/h/1.md
@@ -0,0 +1,7 @@
+# Inleiding
+
+## Doel documentatie
+Dit document beschrijft het releaseprotocol van de <abbr title="Nederlandse CAD-standaard">NLCS</abbr>.
+
+
+
diff --git a/docs/requirementssoftware/h/media/hub.PNG b/docs/requirementssoftware/h/media/hub.PNG
diff --git a/docs/requirementssoftware/h/media/laagopbouw.PNG b/docs/requirementssoftware/h/media/laagopbouw.PNG
diff --git a/docs/requirementssoftware/h/media/publication.PNG b/docs/requirementssoftware/h/media/publication.PNG
diff --git a/docs/requirementssoftware/h/media/publicationdetails.PNG b/docs/requirementssoftware/h/media/publicationdetails.PNG
diff --git a/docs/requirementssoftware/h/media/querien.PNG b/docs/requirementssoftware/h/media/querien.PNG
diff --git a/docs/requirementssoftware/index.html b/docs/requirementssoftware/index.html
@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html lang="nl">
+
+<head>
+  <meta charset='utf-8'>
+  <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+  <!-- Pas hier de titel van het document aan -->
+  <title>Eisen aan software-implementatie</title>
+  <script src="config.js" class="remove"></script>
+  <script src='https://cdn.jsdelivr.net/gh/stichting-crow/respec@latest/builds/respec-stichting-crow.js' async class='remove'></script>
+</head>
+
+<body>
+  <!-- Op https://github.com/stichting-crow/respec/wiki staat een beknopte handleiding voor ReSpec. -->
+  <section id="abstract"       data-include-format="markdown" data-include="h/0-samenvatting.md"></section>
+  <section id="sotd"></section>
+  <section class="informative" data-include-format="markdown" data-include="h/1.md"></section>
+  <section id="conformance"></section>
+  <section id="index"></section>
+  <section class="appendix" id="issue-summary"></section>
+</body>
+
+</html>