VNG-Realisatie / VNG-R-Respec-Organization-configurations

VNG-R global configurations repository voor Respec
https://vng-realisatie.github.io/VNG-R-Respec-Organization-configurations/
Other
0 stars 0 forks source link

Respec documentatie met of zonder links (§)? #2

Closed melsk-r closed 4 months ago

melsk-r commented 7 months ago

M.b.v. de configuratie property 'addSectionLinks' kunnen paragraaftekens (§) voor de secties gegenereerd worden zoals in onderstaande voorbeeld is gedaan.:

image

Indien we hiervoor kiezen kunnen de lezers van het Respec document, door met je rechtermuistoets te klikken op het paragraaf teken , de url naar die sectie kopiëren waarna ze deze in een ander document kunnen plakken. Zo creëer je dus een directe link naar de betreffende sectie. Op dit moment is dit een globale property met de waarde 'false' waardoor ze niet gegenereerd worden. Deze property kan echter lokaal overruled worden.

Willen we inderdaad dat deze globaal de waarde 'false' heeft? Vinden we het toegestaan dat deze lokaal overruled kan worden?

Logius lijkt de gewoonte te hebben het paragraaf teken mee te genereren (zie deze voorbeelden). Bij Geonovum en Kadaster wijken de diverse Respec documenten van elkaar af op dit punt. Voor W3C documenten worden de paragraaftekens standaard wel mee gegenereerd.

Ik heb niet echt een sterke mening over het wel of niet tonen van het paragraaf teken. Ik vind wel dat we alle Respec documenten binnen VNG-R op dit punt op dezelfde wijze moeten genereren. Eenheid uitstralen vind ik van belang. Ik zou er dan ook voor kiezen het niet toe te staan deze property lokaal te overrulen.

LET OP!: Dat laatste is een afspraak die we samen maken, dit kan (nog) niet afgedwongen worden.

hdksi commented 5 months ago

Meeste stemmen van toepassende partijen gelden; met paragraafteken dus wat mij betreft ;)

melsk-r commented 4 months ago

Is als zodanig gedocumenteerd. Lokaal overrulen is toegestaan.