Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ElisabethDeVries committed Jan 8, 2024
1 parent e8fec82 commit 347c139
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 24 deletions.
14 changes: 0 additions & 14 deletions docs/code_documentation/h/4.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,20 +22,6 @@ Binnen de taxonomie van NLCS is de relatie tussen bovenliggende en onderliggende

<div class="issue" data-number="3"></div>

#### Laagnaam
[=CAD-modellen=] zijn opgebouwd in lagen. In de laagnaam wordt het volgende opgenomen:

a-bb-cc-dd-dd-G/S/

* a: <dfn data lt="Status|Statussen">Status</dfn>: In de laagnaam wordt de status van objecten weergegeven, bijvoorbeeld bestaand, nieuw, revisie enzovoorts.
* bb: <dfn data lt="Discipline|Disciplines">Discipline</dfn>: In de laagnaam wordt de discipline van getekende objecten weergegeven, bijvoorbeeld een wegentekening, of een landmeetkundige tekening.
* cc: <dfn data lt="Hoofdcategorie|Hoofdcategoriën">Hoofdcategorie</dfn>: In de laagnaam wordt een groep met objecten aangeduid met twee hoofdletters; dit bevat het eerste niveau onder [=NLCSObject=]
* dd_dd: de naam van het object, beginnen bij een algemeen object (BV = Bermbeveiligingsvoorziening"), daarna een specifieker type object ("GELEIDECONSTRUCTIE"), tot op het diepste niveau van de [=taxonomie=] ("GELEIDECONSTRUCTIE_BEBAKENING")
* G/S/: als laatste wordt aangeduid of in de laag Geometrie (G), symbolen (S) en/of ... bevat. Geometrie en symboeln staan soms op dezelfde laag, soms op een verschillende laag. Dit hangt af van wat het handigst is tijdens het tekenen van het desbetreffende objecttype.

De laagnaam is bij NLCS daarmee een soort "logische code" waar een menselijke lezer veel uit kan afleiden, en waarmee bepaalde onderdelen van een tekening kunnen worden getoond of verborgen, voor visualisatie ten behoeve van een specifiek doel, of voor foutcontrole.
De laagnaam komt voor bij de InformatieObjecten [[=NLCSObject=]] en [[=Symbool=]]



### <dfn>Arcering</dfn>
Expand Down
26 changes: 16 additions & 10 deletions docs/code_documentation/h/5.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,34 @@
# Opbouw NLCS objectentabellen
# Details


### Structuur
1. De NLCS objectentabellen hebben een vaste structuur met 42 kolommen. De omschrijving van de inhoud per kolom is weergegeven in onderstaande tabel.
### Objecten
Van oorsprong hadden de NLCS objectentabellen een vaste structuur met 42 kolommen, deze kunnen gequeried worden in de linked data publicatie. De omschrijving van de inhoud per kolom is weergegeven in onderstaande tabel.

<table class="tabel3">
<caption>De structuur van de NLCS Objectentabellen</caption>
<tr>
<th>Kolommen</th>
<th>Nummer</th>
<th>Inhoud</th>
</tr>
<tr>
<td>URI</td>
<td>Omschrijving: de unieke identifyer van dit object in de linked data publicatie, voorbeeld: example/nlcs/def/c132cd12-d85e-46d8-b862-27c6d713a883 </td>
</tr>
<tr>
<td>A</td>
<td>Omschrijving (objectnaam)</td>
<td>Omschrijving: objectnaam, voorbeeld: Houtvorm</td>
</tr>
<tr>
<td>B</td>
<td>STATUS (per model eenmalig in te voeren, in de objectentabellen aangeduid met “*”</td>
<td>STATUS: per model eenmalig in te voeren, in de objectentabellen aangeduid met “*”</td>
</tr>
<tr>
<td>C</td>
<td>Koppelteken (‘liggend streepje’)</td>
</tr>
<tr>
<td>D</td>
<td>DISCIPLINE (per model eenmalig in te voeren, in de objectentabellen aangeduid met “**”</td>
<td>DISCIPLINE: per model eenmalig in te voeren, in de objectentabellen aangeduid met “**”</td>
</tr>
<tr>
<td>E</td>
Expand Down Expand Up @@ -121,10 +125,12 @@
</table>




2. De inhoud van de cellen in de objectentabellen moet worden geïnterpreteerd als tekst, ook wanneer die inhoud bestaat uit getallen.


### Naamgeving en plaatsing van arceringen
### Arceringen
1. Voor objecten die (kunnen) worden gerepresenteerd door middel van arceringen, zijn binnen NLCS arceringenbibliotheken beschikbaar. De naamgeving van arceringen(-bibliotheken) is als volgt:

[STATUS]-BIBLIOTHEEK-ARCERINGNAAM_[OPT]
Expand Down Expand Up @@ -170,7 +176,7 @@ Hetzelfde object kan desgewenst ook worden gerepresenteerd door geometrie (G). D
3. In principe bestaat een arcering van een OBJECT voor de STATUS V (Vervallen) uit de standaard arcering voor dat OBJECT, aangevuld met een streeparcering onder een hoek van 135o.
4. NLCS bevat een basisset arceringen. Gebruikers, softwareontwikkelaars of toeleveranciers kunnen desgewenst eigen arceringen(-bibliotheken) toevoegen. Om te bewerkstelligen dat deze eigen arceringen worden herkend door, en op de juiste wijze kunnen worden geplaatst met NLCS CAD-applicaties, moet de naamgeving ervan worden opgebouwd als in deze paragraaf is beschreven. De NLCS voorziet niet in het uitwisselen van eigen bibliotheken, houdt dan ook rekening met de mogelijke beperkingen in het uitwisselen van eigen bibliotheken tussen verschillende software applicaties. Bronbestand dienen beschikbaar gesteld te worden indien eigen arceringen buiten de organisatie toegepast dienen te worden.

### Naamgeving en plaatsing van symbolen
### Symbolen
1. Voor objecten die (kunnen) worden gerepresenteerd door middel van symbolen, zijn binnen NLCS symbolen(-bibliotheken) beschikbaar.
2. De naamgeving van symbolen is als volgt:

Expand Down Expand Up @@ -257,7 +263,7 @@ j.4 Definieer het symbool rondom het punt 0-punt.
j.5 Teksten en attributes worden ook op de layer 0 / defeault geplaatst.


### Naamgeving van lijnstijlen
### Lijnstijlen
1. Voor objecten die (kunnen) worden gerepresenteerd door middel van lijnstijlen, zijn binnen NLCS lijnstijl(-bibliotheken) beschikbaar.
2. De naamgeving van lijnstijlen is als volgt:

Expand Down
2 changes: 2 additions & 0 deletions docs/howtoquery/h/4.md
Original file line number Diff line number Diff line change
Expand Up @@ -492,6 +492,8 @@ orderby ?Lineweight
## Tabel object
De [query voor een object](https://github.com/nl-digigo/NLCS/blob/main/code/Query%20NLCS-objects.rq) resulteert in een tabel zoals deze, gespiegeld voor leesbaarheid:

De toelichting op de onderdelen van deze tabel staan in de [Code-documentatie](https://nl-digigo.github.io/NLCS/code_documentation/#objecten)

| NLCSObject | http://data.digigo.nu/nlcs/def/c132cd12-d85e-46d8-b862-27c6d713a883 | http://data.digigo.nu/nlcs/def/e1303c6d-5701-4ffb-a68f-1f9b42aa049c | http://data.digigo.nu/nlcs/def/1e16b5eb-015c-4c1f-9d10-6ba71dfa167b |
| ------------------------------------------------ | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
| OMSCHRIJVING | HOUTVORM | AANGRENZENDE CONSTRUCTIE | VERBINDING |
Expand Down

0 comments on commit 347c139

Please sign in to comment.